{"id":22588971,"url":"https://github.com/matbour/setup-sentry-cli","last_synced_at":"2025-04-10T21:45:20.754Z","repository":{"id":42684825,"uuid":"231841357","full_name":"matbour/setup-sentry-cli","owner":"matbour","description":"Setup the Sentry CLI in GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-10-16T13:39:21.000Z","size":2015,"stargazers_count":19,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T21:45:09.846Z","etag":null,"topics":["github-actions","sentry","sentry-cli"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/setup-sentry-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matbour.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-04T23:11:05.000Z","updated_at":"2025-01-23T17:14:13.000Z","dependencies_parsed_at":"2024-06-19T16:05:28.232Z","dependency_job_id":"a933be26-1d01-4296-86a6-dab5adf1ef4d","html_url":"https://github.com/matbour/setup-sentry-cli","commit_stats":{"total_commits":85,"total_committers":4,"mean_commits":21.25,"dds":"0.15294117647058825","last_synced_commit":"3e938c54b3018bdd019973689ef984e033b0454b"},"previous_names":["matbour/setup-sentry-cli","mathieu-bour/setup-sentry-cli"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matbour%2Fsetup-sentry-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matbour%2Fsetup-sentry-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matbour%2Fsetup-sentry-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matbour%2Fsetup-sentry-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matbour","download_url":"https://codeload.github.com/matbour/setup-sentry-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248305879,"owners_count":21081562,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","sentry","sentry-cli"],"created_at":"2024-12-08T08:11:45.102Z","updated_at":"2025-04-10T21:45:20.735Z","avatar_url":"https://github.com/matbour.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# matbour/setup-sentry-cli\n\n![License][license]\n![Stars][stars]\n![Latest release][latest-release]\n![Workflow status][workflow]\n\nInstall the Sentry CLI in your GitHub Actions workflow.\n\n**This action is not supported by Sentry.**\n\nProudly maintained by [Mathieu Bour][@matbour], former Vice-CTO [@mathrix-education][@mathrix-education].\n\n## Acknowledgements\n\nThis action was initially developed for [Education Media SA][@mathrix-education]. The repository is now maintained\nby [@matbour][@matbour].\n\n## Motivations\n\nInstalling Sentry CLI in GitHub Actions can be relevant in many cases. Mathrix Education SA is based on Angular, which\nproduces sourcemaps. Therefore, we need to upload sourcemaps, during our compilation workflow.\n\nThere is an [official guide to use sentry-cli on the Sentry's blog][2.1], but it requires to use a bunch of commands,\nwhich is not really straight forward.\n\nThere are also some [Docker-based actions][2.2], but they are quite slow.\n\n[2.1]: https://blog.sentry.io/2019/12/17/using-github-actions-to-create-sentry-releases\n[2.2]: https://github.com/marketplace?type=actions\u0026query=sentry\n\n## Usage\n\n### Supported operating systems\n\nThis action currently supports Ubuntu, Windows and Mac-OS based systems. The supported operating system matrix is the\nfollowing:\n\n| Operating system | Status       |\n| ---------------- | ------------ |\n| `ubuntu-latest`  | ![supported] |\n| `macos-latest`   | ![supported] |\n| `windows-latest` | ![supported] |\n\nThis action also support ARM-based systems (armv7 and arm64), thanks to @paresy support.\n\n| Platform | Architecture    | Status       |\n| -------- | --------------- | ------------ |\n| linux    | x32 (i686)      | ![supported] |\n| linux    | x64 (x86_64)    | ![supported] |\n| linux    | arm (armv7)     | ![supported] |\n| linux    | arm64 (aarch64) | ![supported] |\n| darwin   | x64 (x86_64)    | ![supported] |\n| darwin   | arm64           | ![supported] |\n| win32    | x32 (i686)      | ![supported] |\n| win32    | x64 (x86_64)    | ![supported] |\n\n### Inputs\n\n| Name           | Type                  | Default value |\n| -------------- | --------------------- | ------------- |\n| `version`      | `'latest'` / `string` | `'latest'`    |\n| `token`        | `string`              | `''`          |\n| `url`          | `string`              | `''`          |\n| `organization` | `string`              | `''`          |\n| `project`      | `string`              | `''`          |\n\nSee [action.yml](action.yml) for details.\n\n#### `version`\n\nIf you need a precise version of the Sentry CLI, you may provide this input. We strongly advise you to do so since using\nthe latest version may break your workflow if Sentry releases a backward-incompatible version of the sentry-cli.\n\n#### `url`\n\nThe Sentry server URL. By default, this action will configure the Sentry CLI to interact with official Sentry server\nwhich is\n`https://sentry.io`. If you use an on-premise instance, you may provide your server URL here.\n\n#### `token`\n\nThis is the token which will be used by the Sentry CLI to authenticate against the Sentry server. Actually, this will\nexport the `SENTRY_AUTH_TOKEN` environment variable, so the sentry-cli already can log into the server.\n\n##### Organization Internal Integration (recommended)\n\nThis will generate a token that is tied to your organization. Go to Organization Settings \u003e Developer Settings \u003e + New\nInternal Integration. Fill the `Name` with a name of your choice (for example `GitHub Actions`); you will get a token\nthat you can use a Sentry token.\n\nIf you plan to use this action to deploy releases, set the following permissions:\n\n| Name          | Access    |\n| ------------- | --------- |\n| Project       | No Access |\n| Release       | Admin     |\n| Issue \u0026 Event | No Access |\n| Organization  | Read      |\n| Member        | No Access |\n\n##### Personal token\n\nYou can also create personal access token that are tied to your account and use them to impersonate your account. Simply\ngo to Settings \u003e API Keys \u003e Create Next Token.\n\n#### `organization`\n\nDefine the default organization; this will export the `SENTRY_ORG` environment variable.\n\n#### `project`\n\nDefine the default project; this will export the `SENTRY_PROJECT` environment variable.\n\n## Examples\n\n### Minimal configuration\n\n```yaml\n- uses: matbour/setup-sentry-cli@v2 # WARNING: see the latest stable version instead!\n```\n\nBy default, this minimal example will install the latest version of the Sentry CLI, without any authentication.\n\n### Typical CI configuration\n\n```yaml\n- name: Setup Sentry CLI\n  uses: matbour/setup-sentry-cli@v1\n  with:\n    version: latest # optional if 'latest'\n    url: https://sentry.yourcompany.com # optional if you are using https://sentry.io\n    token: ${{ SECRETS.SENTRY_TOKEN }} # from GitHub secrets\n    organization: my-org\n    project: my-project\n```\n\nIn this example, you provide an authentication token. The action automatically download the latest version of the Sentry\nCLI and authenticate using the provided token.\n\nThen, the CLI is configured for the server `https://sentry.yourcompany.com` and the project `my-project` of the\norganization `my-org`.\n\nYou are now ready to use the Sentry CLI commands such as `sentry-cli releases`!\n\n[@matbour]: https://github.com/matbour\n[@mathrix-education]: https://github.com/mathrix-education\n[actions-secrets]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets\n[license]: https://img.shields.io/github/license/matbour/setup-sentry-cli?style=flat-square\n[stars]: https://img.shields.io/github/stars/matbour/setup-sentry-cli?style=flat-square\n[latest-release]: https://img.shields.io/github/v/release/matbour/setup-sentry-cli?label=latest%20release\u0026style=flat-square\n[workflow]: https://img.shields.io/github/workflow/status/matbour/setup-sentry-cli/Tests?style=flat-square\n[supported]: https://img.shields.io/badge/status-supported-brightgreen?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatbour%2Fsetup-sentry-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatbour%2Fsetup-sentry-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatbour%2Fsetup-sentry-cli/lists"}