Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Add Auto Release Detection #800

Draft
smeubank wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Add Auto Release Detection #800

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
84562b1
Update index.mdx
smeubank Jan 4, 2023
3105fdb
Create release.mdx
smeubank Jan 4, 2023
944bd20
Update sidebar.tsx
smeubank Jan 4, 2023
d44aa95
Update release.mdx
smeubank Jan 4, 2023
e4bb06b
Update src/docs/sdk/event-payloads/release.mdx
smeubank Jan 4, 2023
b74778c
Update src/docs/sdk/event-payloads/index.mdx
smeubank Jan 5, 2023
4060e94
Update release.mdx
smeubank Jan 5, 2023
38feb8d
Update release.mdx
smeubank Jan 5, 2023
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
1 change: 1 addition & 0 deletions src/components/sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ export default () => {
Exception Interface
</SidebarLink>
<SidebarLink to="/sdk/event-payloads/message/">Message Interface</SidebarLink>
<SidebarLink to="/sdk/event-payloads/release/">Release Detection</SidebarLink>
<SidebarLink to="/sdk/event-payloads/request/">Request Interface</SidebarLink>
<SidebarLink to="/sdk/event-payloads/sdk/">SDK Interface</SidebarLink>
<SidebarLink to="/sdk/event-payloads/stacktrace/">
Expand Down
4 changes: 4 additions & 0 deletions src/docs/sdk/event-payloads/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ For example, in a web app, this might be the route name.
This value can be the git SHA for the given project, or a product identifier
with a semantic version (suggested format `my-project-name@1.0.0`).

It is suggested to attempt to automatically detect the release environment,
and set it automatically for the user.
Further inforomation about platform specific attempts here.
Comment thread
smeubank marked this conversation as resolved.
Outdated

```json
{
"release": "my-project-name@1.0.0"
Expand Down
45 changes: 45 additions & 0 deletions src/docs/sdk/event-payloads/release.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Detect Release Automatically
---

<Alert title="Note on --- " level="info">
Should we call special attention to something to encourage best practices and prevent and bad DX?
</Alert>


## Release


```json
{
"release": "my-project-name@1.0.0"
}
```

```json
{
"release": "721e41770371db95eee98ca2707686226b993eda"
}
```

## SDK Examples

| Source | Description | <div style="width:220px">Examples</div> |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
| Python SDK | -SENTRY_RELEASE env variable <br /> - Output of git rev-parse HEAD | |
| Rust SDK | | |
| Browser SDK | | |
| Node SDK | | |
| Dart/Flutter | | |
Copy link
Copy Markdown
Member

@bruno-garcia bruno-garcia Jan 4, 2023

Choose a reason for hiding this comment

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

Same here. I'd omit Dart altogether at this point:

Suggested change
| Dart/Flutter | | |
| Flutter | | |

| Java/Android | | |
Copy link
Copy Markdown
Member

@bruno-garcia bruno-garcia Jan 4, 2023

Choose a reason for hiding this comment

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

Java will be different than Android

Copy link
Copy Markdown
Contributor Author

@smeubank smeubank Jan 4, 2023

Choose a reason for hiding this comment

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

https://www.notion.so/sentry/PR-Dev-Auto-release-setting-techniques-a0da5ba23058406ca56be5fe3524d4c4

yep you are right they are separated in the second column here, should just give them both a row, and make android (Java) or something

| Cocoa/Apple | | |
Copy link
Copy Markdown
Member

@bruno-garcia bruno-garcia Jan 4, 2023

Choose a reason for hiding this comment

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

Suggested change
| Cocoa/Apple | | |
| Apple | | |

| React Native | | |
| Unity | | |
| Unreal Engine | | |
| Capacitor | | |
| Cordova | | |
| UXamarin | | |
Comment thread
smeubank marked this conversation as resolved.
Outdated
| PHP | | |
| Ruby | | |
| Golang | | |
| .NET | | |