Skip to content

fix(releases): Add note about repo name when associating commits #7646

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 16, 2023
Merged

fix(releases): Add note about repo name when associating commits #7646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions src/docs/product/cli/releases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ In case you are deploying without access to the git repository, you can manually
sentry-cli releases set-commits "$VERSION" --commit "my-repo@deadbeef"
```

<Note>
The repository name `my-repo` should match the name you entered when linking
the repo, and should be in the form `owner-name/repo-name`.
</Note>

To see which repos are available for the organization, you can run `sentry-cli repos list` which will return a list of configured repositories.

Note that you need to refer to releases you need to use the actual full commit SHA. If you want to refer to tags or references (like _HEAD_), the repository needs to be checked out and reachable from the path where you invoke _sentry-cli_.
Expand Down
7 changes: 6 additions & 1 deletion src/docs/product/releases/associate-commits/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,17 @@ sentry-cli releases set-commits --local $VERSION

For more control over which commits to associate, or if you're unable to execute the command inside the repository, you can manually specify a repository and range.

The following example associates commits (or refs) between `from` and `to` with the current release, where `from` is the previous release’s commit. The repository name `my-repo` should match the name you entered when linking the repo using the form `owner-name/repo-name`. The `from` commit is optional; we’ll use the previous release’s commit as the baseline if it is excluded:
The following example associates commits (or refs) between `from` and `to` with the current release, where `from` is the previous release’s commit. The `from` commit is optional; we’ll use the previous release’s commit as the baseline if it is excluded:

```bash
sentry-cli releases set-commits --commit "my-repo@from..to" $VERSION
```

<Note>
The repository name `my-repo` should match the name you entered when linking
the repo, and should be in the form `owner-name/repo-name`.
</Note>

### Using the API

To send Sentry your commit metadata using the API, use the [create release endpoint](/api/releases/create-a-new-release-for-an-organization/).
Expand Down