Skip to content

Commit 8672cc5

Browse files
authored
fix(releases): Add note about repo name when associating commits (#7646)
A customer recently ran into trouble because they were trying to associate commits using the form `some-repo@123abc` rather than the form `some-org/some-repo@123abc`. Though we do have a note about this in the docs, in the section on releases, it's easy to miss. We also don't mention it at all in the CLI docs. This fixes that by pulling it out into a highlighted note in both places.
1 parent be5bd74 commit 8672cc5

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

src/docs/product/cli/releases.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ In case you are deploying without access to the git repository, you can manually
7474
sentry-cli releases set-commits "$VERSION" --commit "my-repo@deadbeef"
7575
```
7676

77+
<Note>
78+
The repository name `my-repo` should match the name you entered when linking
79+
the repo, and should be in the form `owner-name/repo-name`.
80+
</Note>
81+
7782
To see which repos are available for the organization, you can run `sentry-cli repos list` which will return a list of configured repositories.
7883

7984
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_.

src/docs/product/releases/associate-commits/index.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,17 @@ sentry-cli releases set-commits --local $VERSION
5555

5656
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.
5757

58-
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:
58+
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:
5959

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

64+
<Note>
65+
The repository name `my-repo` should match the name you entered when linking
66+
the repo, and should be in the form `owner-name/repo-name`.
67+
</Note>
68+
6469
### Using the API
6570

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

0 commit comments

Comments
 (0)