Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix(action): Use action/setup-node instead of unofficial volta action #256

Merged
merged 3 commits into from
Feb 10, 2025
Merged

fix(action): Use action/setup-node instead of unofficial volta action #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4d4816
fix(action): Use `action/setup-node` instead of unofficial volta action
andreiborza Feb 10, 2025
ffcb730
Add `disable_safe_directory` to README
andreiborza Feb 10, 2025
7135504
Use `node-version`
andreiborza Feb 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,24 +70,26 @@ Adding the following to your workflow will create a new Sentry release and tell

#### Parameters

|name| description |default|
|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
|`environment`| Set the environment for this release. E.g. "production" or "staging". Omit to skip adding deploy to release. |-|
|`inject`| Injects Debug IDs into source files and sourcemaps. We **strongly recommend enabling** this to ensure proper un-minifaction of your stacktraces. |`false`|
|`sourcemaps`| Space-separated list of paths to JavaScript sourcemaps. Omit to skip uploading sourcemaps. |-|
|`finalize`| When false, omit marking the release as finalized and released. |`true`|
|`ignore_missing`| When the flag is set and the previous release commit was not found in the repository, will create a release with the default commits count instead of failing the command. |`false`|
|`ignore_empty`| When the flag is set, command will not fail and just exit silently if no new commits for a given release have been found. |`false`|
|`dist`| Unique identifier for the distribution, used to further segment your release. Usually your build number. |-|
|`started_at`| Unix timestamp of the release start date. Omit for current time. |-|
|`version`| Identifier that uniquely identifies the releases. _Note: the `refs/tags/` prefix is automatically stripped when `version` is `github.ref`._ |<code>${{&nbsp;github.sha&nbsp;}}</code>|
|`version_prefix`| Value prepended to auto-generated version. For example "v". |-|
|`set_commits`| Specify whether to set commits for the release. Either "auto" or "skip". |"auto"|
|`projects`| Space-separated list of paths of projects. When omitted, falls back to the environment variable `SENTRY_PROJECT` to determine the project. |-|
|`url_prefix`| Adds a prefix to source map urls after stripping them. |-|
|`strip_common_prefix`| Will remove a common prefix from uploaded filenames. Useful for removing a path that is build-machine-specific. |`false`|
|`working_directory`| Directory to collect sentry release information from. Useful when collecting information from a non-standard checkout directory. |-|
|`disable_telemetry`| The action sends telemetry data and crash reports to Sentry. This helps us improve the action. You can turn this off by setting this flag. |`false`|
| name | description |default|
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| `environment` | Set the environment for this release. E.g. "production" or "staging". Omit to skip adding deploy to release. |-|
| `inject` | Injects Debug IDs into source files and sourcemaps. We **strongly recommend enabling** this to ensure proper un-minifaction of your stacktraces. |`false`|
| `sourcemaps` | Space-separated list of paths to JavaScript sourcemaps. Omit to skip uploading sourcemaps. |-|
| `finalize` | When false, omit marking the release as finalized and released. |`true`|
| `ignore_missing` | When the flag is set and the previous release commit was not found in the repository, will create a release with the default commits count instead of failing the command. |`false`|
| `ignore_empty` | When the flag is set, command will not fail and just exit silently if no new commits for a given release have been found. |`false`|
| `dist` | Unique identifier for the distribution, used to further segment your release. Usually your build number. |-|
| `started_at` | Unix timestamp of the release start date. Omit for current time. |-|
| `version` | Identifier that uniquely identifies the releases. _Note: the `refs/tags/` prefix is automatically stripped when `version` is `github.ref`._ |<code>${{&nbsp;github.sha&nbsp;}}</code>|
| `version_prefix` | Value prepended to auto-generated version. For example "v". |-|
| `set_commits` | Specify whether to set commits for the release. Either "auto" or "skip". |"auto"|
| `projects` | Space-separated list of paths of projects. When omitted, falls back to the environment variable `SENTRY_PROJECT` to determine the project. |-|
| `url_prefix` | Adds a prefix to source map urls after stripping them. |-|
| `strip_common_prefix` | Will remove a common prefix from uploaded filenames. Useful for removing a path that is build-machine-specific. |`false`|
| `working_directory` | Directory to collect sentry release information from. Useful when collecting information from a non-standard checkout directory. |-|
| `disable_telemetry` | The action sends telemetry data and crash reports to Sentry. This helps us improve the action. You can turn this off by setting this flag. |`false`|
| `disable_safe_directory` | The action needs access to the repo it runs in. For that we need to configure git to mark the repo as a safe directory. You can turn this off by setting this flag. |`false`|


### Examples

Expand Down
26 changes: 25 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,33 @@ inputs:
disable_telemetry:
description: 'The action sends telemetry data and crash reports to Sentry. This helps us improve the action. You can turn this off by setting this flag.'
required: false
disable_safe_directory:
description: 'The action needs access to the repo it runs in. For that we need to configure git to mark the repo as a safe directory. You can turn this off by setting this flag.'
required: false

runs:
using: 'composite'
steps:
- uses: volta-cli/action@v4
- name: Mark GitHub workspace a safe directory in git
if: ${{ inputs.disable_safe_directory != 'true' }}
shell: bash
run: |
git config --global --add safe.directory ${{ github.workspace }}

- name: Get node version
shell: bash
run: |
echo "NODE_VERSION=$(node -v 2>/dev/null || echo '')" >> $GITHUB_ENV

- name: Setup node
# Only install node if there isn't one already
if: env.NODE_VERSION == ''
uses: actions/setup-node@v4
with:
# setup-node doesn't allow absolute paths, so we can't
# just use `github.action_path` to read this out from the `package.json`
# any changes to the runtime need to be reflected here
node-version: 18.17.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we use the latest 18 version?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pinned to what's in the package.json. For now I'll keep it like this but will look into bumping this in another PR.


- name: Install Sentry CLI v2
shell: bash
Expand Down Expand Up @@ -83,9 +105,11 @@ runs:
INPUT_STRIP_COMMON_PREFIX: ${{ inputs.strip_common_prefix }}
INPUT_WORKING_DIRECTORY: ${{ inputs.working_directory }}
INPUT_DISABLE_TELEMETRY: ${{ inputs.disable_telemetry }}
INPUT_DISABLE_SAFE_DIRECTORY: ${{ inputs.disable_safe_directory }}
shell: bash
run: npm run start
working-directory: ${{ github.action_path }}

branding:
icon: 'triangle'
color: 'purple'