From 81661b4fe30001cf0e978c91f1ba8f4972a16ee8 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Wed, 18 May 2022 19:16:32 -0400 Subject: [PATCH 1/6] restructured page --- .../releases/suspect-commits/index.mdx | 50 +++++++++++-------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/src/docs/product/releases/suspect-commits/index.mdx b/src/docs/product/releases/suspect-commits/index.mdx index b23cdc159cdc3..3db34cfe8b0a5 100644 --- a/src/docs/product/releases/suspect-commits/index.mdx +++ b/src/docs/product/releases/suspect-commits/index.mdx @@ -4,7 +4,13 @@ sidebar_order: 2 description: "Learn how to associate commits to a release to track suspect commits." --- -In your release process, add a step to create a release in Sentry and associate it with commits from your linked repository. We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, especially if you're using [Release Automation](/product/releases/setup/release-automation/). +In your release process, add a step to create a release in Sentry and associate it with commits from your linked repository. + +After this step, suspect commits and suggested assignees will display on the Issues page. + +![](suspect-commits-highlighted.png) + +We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, especially if you're using [Release Automation](/product/releases/setup/release-automation/). After this, we can tie together the commits in the release, including: @@ -21,6 +27,7 @@ This process assumes: ## Using the CLI In this CLI example: + - Environment variables configure the CLI (see [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) for alternatives) - The `propose-version` sub-command determines a release ID automatically - A release tagged `VERSION` is created for the organization `my-org` for projects (`project1` and `project2`) @@ -55,26 +62,7 @@ sentry-cli releases set-commits --commit "my-repo@from..to" $VERSION For more information, see our [CLI docs](/product/cli/releases/). -After this step, suspect commits and suggested assignees will display on the Issues page. - -![](suspect-commits-highlighted.png) - -Additionally, you will be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the Issue Details page, next to the assignee dropdown. For example, a commit message might look like this: - -```bash -Prevent empty queries on users - -Fixes SENTRY-317 -``` - -When Sentry sees this commit, we’ll reference the commit in the issue, and when you create a release in Sentry we’ll mark the issue as resolved in that release. - - - -If you’re using GitHub, you may have a privacy setting enabled that prevents Sentry from identifying the user’s actual email address. To use the suggested owners feature, uncheck “Keep my email address private” in GitHub’s [account settings](https://github.com/settings/emails). - - - + + ## Using the API @@ -161,3 +151,21 @@ For more information, see the [API reference](/api/releases/create-a-new-release If you receive an "Unable to Fetch Commits" email, take a look at our [Help Center Article](https://help.sentry.io/hc/en-us/articles/360019866834-Why-am-I-receiving-the-email-Unable-to-Fetch-Commits-). + +## Resolving by Commit + +Additionally, you will be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the Issue Details page, next to the assignee dropdown. For example, a commit message might look like this: + +```bash +Prevent empty queries on users + +Fixes SENTRY-317 +``` + +When Sentry sees this commit, we’ll reference the commit in the issue, and when you create a release in Sentry we’ll mark the issue as resolved in that release. + + + +If you’re using GitHub, you may have a privacy setting enabled that prevents Sentry from identifying the user’s actual email address. To use the suggested owners feature, uncheck “Keep my email address private” in GitHub’s [account settings](https://github.com/settings/emails). + + From 19c0f8d8921a58c3f99aa40305fb322a77f2e55a Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Thu, 19 May 2022 13:59:14 -0400 Subject: [PATCH 2/6] restructured page --- src/docs/product/cli/releases.mdx | 8 ++- .../releases/suspect-commits/index.mdx | 64 +++++++++---------- 2 files changed, 38 insertions(+), 34 deletions(-) diff --git a/src/docs/product/cli/releases.mdx b/src/docs/product/cli/releases.mdx index c22197b21ab3f..8a05b5daaf5d3 100644 --- a/src/docs/product/cli/releases.mdx +++ b/src/docs/product/cli/releases.mdx @@ -32,9 +32,13 @@ Releases can also be auto created by different systems. For instance upon upload ## Finalizing Releases -By default a release is created “unreleased”. Finalizing a release means that we fill in a second timestamp on the release record, which is prioritized over `date_created` when sorting releases in the UI. This also affects what counts as "the next release" for resolving issues, what release is used as the base for associating commits if you use `--auto`, and creates an entry in the Activity stream. +By default a release is created “unreleased”. Finalizing a release means that we populate a second timestamp on the release record, which is prioritized over `date_created` when sorting releases in [sentry.io](https://sentry.io). Release finalization (and the timestamp) also affects: -This can be changed by passing either `--finalize` to the `new` command which will immediately finalize the release or you can separately call `sentry-cli releases finalize VERSION` later on. The latter is useful if you are managing releases as part of a build process e.g. +- What counts as "the next release" for resolving issues +- What release is used as the base for associating commits if you use `--auto` +- Creates an entry in the Activity stream. + +You can change this by passing either `--finalize` to the `new` command, which will immediately finalize the release, or by separately calling `sentry-cli releases finalize VERSION` later on, which is useful if you are managing releases as part of a build process. For example: ```bash #!/bin/sh diff --git a/src/docs/product/releases/suspect-commits/index.mdx b/src/docs/product/releases/suspect-commits/index.mdx index 3db34cfe8b0a5..b4f953bbaaa43 100644 --- a/src/docs/product/releases/suspect-commits/index.mdx +++ b/src/docs/product/releases/suspect-commits/index.mdx @@ -1,30 +1,51 @@ --- -title: Enable Suspect Commits +title: Suspect Commits sidebar_order: 2 description: "Learn how to associate commits to a release to track suspect commits." --- In your release process, add a step to create a release in Sentry and associate it with commits from your linked repository. -After this step, suspect commits and suggested assignees will display on the Issues page. +## Suspect Commits & Suggested Assignees -![](suspect-commits-highlighted.png) +After this step, suspect commits and suggested assignees will display on the **Issues** page. -We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, especially if you're using [Release Automation](/product/releases/setup/release-automation/). +![](suspect-commits-highlighted.png) -After this, we can tie together the commits in the release, including: +We can tie together the commits in the release, including: - Files touched by those commits - Files observed in the stack trace - Authors of those files - The issue number in a commit message +## Resolve Issues by Commit + +Additionally, you will be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the Issue Details page, next to the assignee dropdown. For example, a commit message might look like this: + +```bash +Prevent empty queries on users + +Fixes SENTRY-317 +``` + +When Sentry sees this commit, we’ll reference the commit in the issue, and when you create a release in Sentry we’ll mark the issue as resolved in that release. + + + +If you’re using GitHub, you may have a privacy setting enabled that prevents Sentry from identifying the user’s actual email address. To use the suggested owners feature, uncheck “Keep my email address private” in GitHub’s [account settings](https://github.com/settings/emails). + + + +## Enable Suspect Commits + +We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, whether you're doing this manually or using [Release Automation](/product/releases/setup/release-automation/). This process assumes: -- the SDK is [configured to provide a release identifier](/platform-redirect/?next=/configuration/releases/) -- [Source maps](/platforms/javascript/sourcemaps/) have been uploaded +- The SDK is [configured to provide a release identifier](/platform-redirect/?next=/configuration/releases/) +- Source maps — or your platform-specific files for mapping transformed source code to the original source — have been uploaded (check out the docs for your [specific platform](/platforms/)) -## Using the CLI +### Using the CLI In this CLI example: @@ -60,30 +81,9 @@ The following example associates commits (or refs) between `from` and `to` with sentry-cli releases set-commits --commit "my-repo@from..to" $VERSION ``` -For more information, see our [CLI docs](/product/cli/releases/). - - +If [finalizing the release](/product/cli/releases/#finalizing-releases) isn't already included as part of your release automation, make sure to do that. For more information, see our [CLI docs](/product/cli/releases/). -## Using the API +### Using the API @@ -152,7 +152,7 @@ If you receive an "Unable to Fetch Commits" email, take a look at our [Help Cent -## Resolving by Commit +## Resolve Issues by Commit Additionally, you will be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the Issue Details page, next to the assignee dropdown. For example, a commit message might look like this: From 77edbebe9808fd565a7de349ee2ec20a84942df3 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana Date: Mon, 30 May 2022 15:13:03 -0400 Subject: [PATCH 3/6] restructured enable suspect commits page --- .../product/issues/states-triage/index.mdx | 2 +- .../releases/setup/manual-setup-releases.mdx | 7 +++ .../releases/suspect-commits/index.mdx | 49 ++++++------------- 3 files changed, 23 insertions(+), 35 deletions(-) diff --git a/src/docs/product/issues/states-triage/index.mdx b/src/docs/product/issues/states-triage/index.mdx index e70fe262d217a..e380206738a71 100644 --- a/src/docs/product/issues/states-triage/index.mdx +++ b/src/docs/product/issues/states-triage/index.mdx @@ -38,7 +38,7 @@ Triage typically involves one or more of the following actions. ### Resolve -Resolve an issue when it's fixed or you don't expect it to happen again. You can do this manually or by [including the issue ID in a commit](/product/integrations/source-code-mgmt/github/#resolve-via-commit-or-pull-request). In addition, you can resolve issues by setting the auto-resolve value. +Resolve an issue when it's fixed or you don't expect it to happen again. You can do this manually or by [including the issue ID in a commit](/product/releases/suspect-commits/#resolve-issues-by-commit). In addition, you can resolve issues by setting the auto-resolve value. The "Auto Resolve" feature allows you to specify an interval after the last occurrence of an issue when it should be automatically resolved. To check if this has been defined for a project, go to **[Project] > Settings > General Settings** and check the "Event Settings" section. diff --git a/src/docs/product/releases/setup/manual-setup-releases.mdx b/src/docs/product/releases/setup/manual-setup-releases.mdx index 04ed378f1cce7..928f23caf2f4e 100644 --- a/src/docs/product/releases/setup/manual-setup-releases.mdx +++ b/src/docs/product/releases/setup/manual-setup-releases.mdx @@ -8,6 +8,13 @@ If you don’t want [install a repository integration](/product/releases/setup/r ## Using the CLI +In this CLI example: + +- Environment variables configure the CLI (see [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) for alternatives) +- The `propose-version` sub-command determines a release ID automatically +- A release tagged `VERSION` is created for the organization `my-org` for projects (`project1` and `project2`) +- The `--auto` flag determines the repository name automatically, and associates commits between the previous release’s commit and the current head commit with the release. + ```bash # Assumes you're in a git repository export SENTRY_AUTH_TOKEN=... diff --git a/src/docs/product/releases/suspect-commits/index.mdx b/src/docs/product/releases/suspect-commits/index.mdx index b4f953bbaaa43..f3719fcae3712 100644 --- a/src/docs/product/releases/suspect-commits/index.mdx +++ b/src/docs/product/releases/suspect-commits/index.mdx @@ -4,24 +4,29 @@ sidebar_order: 2 description: "Learn how to associate commits to a release to track suspect commits." --- -In your release process, add a step to create a release in Sentry and associate it with commits from your linked repository. +In your release process, you can add a step to create a release in Sentry and associate it with commits from your linked repository. When you've done this, you'll be able to: -## Suspect Commits & Suggested Assignees +- See suspect commits and suggested assignees in issues +- Resolve issues by commit -After this step, suspect commits and suggested assignees will display on the **Issues** page. +If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, suspect commits should already be enabled. -![](suspect-commits-highlighted.png) +## Suspect Commits & Suggested Assignees -We can tie together the commits in the release, including: +When you've enabled suspect commits, we can tie together the commits in the release, including: - Files touched by those commits - Files observed in the stack trace - Authors of those files - The issue number in a commit message +Suspect commits and suggested assignees will then display on the **Issue Details** page: + +![](suspect-commits-highlighted.png) + ## Resolve Issues by Commit -Additionally, you will be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the Issue Details page, next to the assignee dropdown. For example, a commit message might look like this: +Additionally, when you've enabled suspect commits, youll be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the **Issue Details** page, next to the assignee dropdown. For example, a commit message might look like this: ```bash Prevent empty queries on users @@ -29,7 +34,7 @@ Prevent empty queries on users Fixes SENTRY-317 ``` -When Sentry sees this commit, we’ll reference the commit in the issue, and when you create a release in Sentry we’ll mark the issue as resolved in that release. +When Sentry sees this commit, we’ll reference the commit in the issue, and when you create a release in Sentry, we’ll mark the issue as resolved in that release. @@ -39,7 +44,8 @@ If you’re using GitHub, you may have a privacy setting enabled that prevents S ## Enable Suspect Commits -We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, whether you're doing this manually or using [Release Automation](/product/releases/setup/release-automation/). +We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, whether you're doing this manually or using release automation. If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, this step should already be included, but the information below can help you troubleshoot. + This process assumes: - The SDK is [configured to provide a release identifier](/platform-redirect/?next=/configuration/releases/) @@ -47,12 +53,7 @@ This process assumes: ### Using the CLI -In this CLI example: - -- Environment variables configure the CLI (see [Working with Projects](/product/cli/configuration/#sentry-cli-working-with-projects) for alternatives) -- The `propose-version` sub-command determines a release ID automatically -- A release tagged `VERSION` is created for the organization `my-org` for projects (`project1` and `project2`) -- The `--auto` flag determines the repository name automatically, and associates commits between the previous release’s commit and the current head commit with the release. +In this CLI example, the `--auto` flag determines the repository name automatically, and associates commits between the previous release’s commit and the current head commit with the release. @@ -81,8 +82,6 @@ The following example associates commits (or refs) between `from` and `to` with sentry-cli releases set-commits --commit "my-repo@from..to" $VERSION ``` -If [finalizing the release](/product/cli/releases/#finalizing-releases) isn't already included as part of your release automation, make sure to do that. For more information, see our [CLI docs](/product/cli/releases/). - ### Using the API @@ -151,21 +150,3 @@ For more information, see the [API reference](/api/releases/create-a-new-release If you receive an "Unable to Fetch Commits" email, take a look at our [Help Center Article](https://help.sentry.io/hc/en-us/articles/360019866834-Why-am-I-receiving-the-email-Unable-to-Fetch-Commits-). - -## Resolve Issues by Commit - -Additionally, you will be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the Issue Details page, next to the assignee dropdown. For example, a commit message might look like this: - -```bash -Prevent empty queries on users - -Fixes SENTRY-317 -``` - -When Sentry sees this commit, we’ll reference the commit in the issue, and when you create a release in Sentry we’ll mark the issue as resolved in that release. - - - -If you’re using GitHub, you may have a privacy setting enabled that prevents Sentry from identifying the user’s actual email address. To use the suggested owners feature, uncheck “Keep my email address private” in GitHub’s [account settings](https://github.com/settings/emails). - - From a1e1761eb528f8cb0bf183b7d25d48d8a90c89b9 Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Mon, 30 May 2022 15:31:17 -0400 Subject: [PATCH 4/6] fixes to improve flow --- src/docs/product/releases/suspect-commits/index.mdx | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/src/docs/product/releases/suspect-commits/index.mdx b/src/docs/product/releases/suspect-commits/index.mdx index f3719fcae3712..ea369b673476c 100644 --- a/src/docs/product/releases/suspect-commits/index.mdx +++ b/src/docs/product/releases/suspect-commits/index.mdx @@ -1,15 +1,13 @@ --- title: Suspect Commits sidebar_order: 2 -description: "Learn how to associate commits to a release to track suspect commits." +description: "Learn how associating commits to a release allows you to track suspect commits." --- -In your release process, you can add a step to create a release in Sentry and associate it with commits from your linked repository. When you've done this, you'll be able to: +In your release process, you can add a step to create a release in Sentry and associate it with commits from your linked repository. When you've done this, you'll be able to see suspect commits and suggested assignees in issues, and resolve issues by commit, as described below. -- See suspect commits and suggested assignees in issues -- Resolve issues by commit -If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, suspect commits should already be enabled. +If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, suspect commits should already be enabled. However, we've included directions for enabling suspect commits using the [Sentry CLI](#using-the-cli) and [our API](#using-the-api) at the end of this page, just in case you need them. ## Suspect Commits & Suggested Assignees @@ -22,7 +20,7 @@ When you've enabled suspect commits, we can tie together the commits in the rele Suspect commits and suggested assignees will then display on the **Issue Details** page: -![](suspect-commits-highlighted.png) +![The suspect commits and suggested assignees for an issue](suspect-commits-highlighted.png) ## Resolve Issues by Commit From c77deaeb2a335046bf6434c7e08886b74e6894b8 Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Mon, 30 May 2022 16:09:31 -0400 Subject: [PATCH 5/6] fixing typo and clarifying language --- src/docs/product/releases/suspect-commits/index.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/docs/product/releases/suspect-commits/index.mdx b/src/docs/product/releases/suspect-commits/index.mdx index ea369b673476c..ae5b505b64b6e 100644 --- a/src/docs/product/releases/suspect-commits/index.mdx +++ b/src/docs/product/releases/suspect-commits/index.mdx @@ -18,13 +18,15 @@ When you've enabled suspect commits, we can tie together the commits in the rele - Authors of those files - The issue number in a commit message -Suspect commits and suggested assignees will then display on the **Issue Details** page: +Suspect commits and suggested assignees will then display on the **Issue Details** page in [sentry.io](https://sentry.io): ![The suspect commits and suggested assignees for an issue](suspect-commits-highlighted.png) ## Resolve Issues by Commit -Additionally, when you've enabled suspect commits, youll be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the **Issue Details** page, next to the assignee dropdown. For example, a commit message might look like this: +Additionally, when you've enabled suspect commits, you'll be able to resolve issues by including the issue ID in your commit message. You can find the issue ID at the top of the **Issue Details** page, next to the assignee dropdown. + +A commit message might look like this, for example: ```bash Prevent empty queries on users @@ -42,7 +44,7 @@ If you’re using GitHub, you may have a privacy setting enabled that prevents S ## Enable Suspect Commits -We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, whether you're doing this manually or using release automation. If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, this step should already be included, but the information below can help you troubleshoot. +We recommend using Sentry’s [Command Line Interface](/product/cli/releases/) or [our API](/product/releases/setup/manual-setup-releases/#using-the-api) to add this step in your release process, whether you're doing this manually or using release automation. If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, this step should already be included, but we've included the relevant code below just in case. This process assumes: From 7f98f81cfb0a1b2b85313a7044db9ff6b82978bc Mon Sep 17 00:00:00 2001 From: Isabel <76437239+imatwawana@users.noreply.github.com> Date: Wed, 1 Jun 2022 16:37:45 -0400 Subject: [PATCH 6/6] wording fixes --- src/docs/product/cli/releases.mdx | 3 ++- src/docs/product/releases/suspect-commits/index.mdx | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/docs/product/cli/releases.mdx b/src/docs/product/cli/releases.mdx index 8a05b5daaf5d3..f16b345fe5bf0 100644 --- a/src/docs/product/cli/releases.mdx +++ b/src/docs/product/cli/releases.mdx @@ -36,7 +36,8 @@ By default a release is created “unreleased”. Finalizing a release means tha - What counts as "the next release" for resolving issues - What release is used as the base for associating commits if you use `--auto` -- Creates an entry in the Activity stream. + +In addition, it creates an entry in the **Activity** stream. You can change this by passing either `--finalize` to the `new` command, which will immediately finalize the release, or by separately calling `sentry-cli releases finalize VERSION` later on, which is useful if you are managing releases as part of a build process. For example: diff --git a/src/docs/product/releases/suspect-commits/index.mdx b/src/docs/product/releases/suspect-commits/index.mdx index ae5b505b64b6e..d6c671fad9026 100644 --- a/src/docs/product/releases/suspect-commits/index.mdx +++ b/src/docs/product/releases/suspect-commits/index.mdx @@ -4,7 +4,7 @@ sidebar_order: 2 description: "Learn how associating commits to a release allows you to track suspect commits." --- -In your release process, you can add a step to create a release in Sentry and associate it with commits from your linked repository. When you've done this, you'll be able to see suspect commits and suggested assignees in issues, and resolve issues by commit, as described below. +In your release process, you can add a step to create a release in Sentry and associate it with commits from your linked repository. When you've done this, you'll be able to see suspect commits and suggested assignees in issues, as well as resolve issues by commit, as described below. If you're using one of our [release automation](/product/releases/setup/release-automation/) options or our [manual setup](/product/releases/setup/manual-setup-releases/) instructions, suspect commits should already be enabled. However, we've included directions for enabling suspect commits using the [Sentry CLI](#using-the-cli) and [our API](#using-the-api) at the end of this page, just in case you need them.