Skip to content

Added docs on SentryCreateRelease and SentrySetCommits #10905

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 2 commits into from
Aug 2, 2024
Merged

Added docs on SentryCreateRelease and SentrySetCommits #10905

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4314a99
Added docs on SentryCreateRelease and SentrySetCommits
jamescrosswell Jul 30, 2024
4bcbc09
Update docs/platforms/dotnet/common/configuration/msbuild.mdx
bitsandfoxes Jul 31, 2024
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
33 changes: 33 additions & 0 deletions docs/platforms/dotnet/common/configuration/msbuild.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,15 @@ if you only want these features enabled in a GitHub Actions CI workflow, you cou
Enable the features you wish to use.
-->

<!-- Automatically creates a release when building your application. -->
<SentryCreateRelease>true</SentryCreateRelease>

<!-- Automatically associates commits with the release. -->
<SentrySetCommits>true</SentrySetCommits>

<!-- Optionally provide explicit flags to the set-commits command -->
<SentrySetCommitOptions>--local</SentrySetCommitOptions>

<!-- Sends symbols to Sentry, enabling symbolication of stack traces. -->
<SentryUploadSymbols>true</SentryUploadSymbols>

Expand Down Expand Up @@ -155,6 +164,30 @@ The URL to your Sentry server. Required only if self-hosting Sentry. (Do not use

There are a few additional properties available to control the Sentry CLI:

<ConfigKey name="SentryCreateRelease">

Enable to automatically create release when building your application. Defaults to `false` (disabled).

Sentry will try to determine the release version automatically by checking the following sources in order:
1. The `SENTRY_RELEASE` environment variable, if set
2. The `AssemblyInformationalVersionAttribute`, if defined
3. The version of the entry assembly for the project
4. The version suggested by running `sentry-cli releases propose-version`

</ConfigKey>

<ConfigKey name="SentrySetCommits">

Enable `SentrySetCommits` to automatically [associate commits with the release](https://docs.sentry.io/cli/releases/#commit-integration).

</ConfigKey>

<ConfigKey name="SentrySetCommitOptions">

By default, when `SentrySetCommits` is enabled, the SDK will set commits with the `--auto` flag. The optional `SentrySetCommitOptions` property allows you to override this to provide whatever flags you want to the `set-commits` CLI command.

</ConfigKey>

<ConfigKey name="SentryUploadSymbols">

Controls uploading symbols to Sentry during the build. Defaults to `false` (disabled).
Expand Down