From 400ccdfd7b0c077f40cfa27b097bd36bc6cafee2 Mon Sep 17 00:00:00 2001 From: Katie Byers Date: Wed, 16 Aug 2023 16:12:29 -0700 Subject: [PATCH] add note about repo name --- src/docs/product/cli/releases.mdx | 5 +++++ src/docs/product/releases/associate-commits/index.mdx | 7 ++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/docs/product/cli/releases.mdx b/src/docs/product/cli/releases.mdx index 12d2339f61e1a..b7e687a5de3f7 100644 --- a/src/docs/product/cli/releases.mdx +++ b/src/docs/product/cli/releases.mdx @@ -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" ``` + + 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`. + + 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_. diff --git a/src/docs/product/releases/associate-commits/index.mdx b/src/docs/product/releases/associate-commits/index.mdx index 2cb759535724a..ab96506eba4f3 100644 --- a/src/docs/product/releases/associate-commits/index.mdx +++ b/src/docs/product/releases/associate-commits/index.mdx @@ -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 ``` + + 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`. + + ### 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/).