Skip to content
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.

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

More ClientOptions.Release documentation #366

Merged
merged 1 commit into from
Jul 19, 2021
Merged

Conversation

rhcarvalho
Copy link
Contributor

  • Briefly explain importance of setting a release
  • Document that release may be derived from env or git
  • Recommend setting the release during build
  • Apply build-time release pattern to examples

This is a follow up on #363.

- Briefly explain importance of setting a release
- Document that release may be derived from env or git
- Recommend setting the release during build
- Apply build-time release pattern to examples
Comment on lines +25 to +30
// release is the release of this program that will be reported to Sentry.
// Use go build -ldflags='-X main.release=VALUE' to set this value in build
// time.
// If not set, a default release value will be derived in runtime from
// environment variables or the Git repository in the current working directory.
var release string
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we're happy with this suggestion, I'd add the same to other examples, and a similar bit of explanation to https://docs.sentry.io.

Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the added context, and agree that we should update the docs site.

@rhcarvalho rhcarvalho merged commit 8f1d2c2 into master Jul 19, 2021
@rhcarvalho rhcarvalho deleted the rhcarvalho/release-docs branch July 19, 2021 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants