Skip to content

Commit 7f24aa8

Browse files
author
NisanthanNanthakumar
authored
feat(codeowners): Add EA docs for Code Owners (#3931)
1 parent 8899d82 commit 7f24aa8

File tree

6 files changed

+64
-0
lines changed

6 files changed

+64
-0
lines changed

src/docs/product/integrations/source-code-mgmt/github/index.mdx

+14
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,20 @@ Stack trace linking takes you from a file in your Sentry stack trace to that sam
247247
1. If the filename in your Sentry stack trace frame doesn't match the path to your source code, you will need to replace the **stack_root** part of the filename with your **source_root** to make the filename match the source code path.
248248
- ex. For example, to get `src/code.py` to match `code.py` when the source code path is `https://github.com/MeredithAnya/testing/blob/main/code.py`, change the **stack trace root** to be set as `src/`, and leave **source code root** empty.
249249

250+
### Code Owners
251+
252+
<Note>
253+
254+
This feature is available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony. If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
255+
256+
Let us know if you have feedback: [[email protected]](mailto:[email protected]).
257+
258+
</Note>
259+
260+
Import your existing GitHub CODEOWNERS files to automatically assign Sentry issues and route alerts to the responsible individuals and teams.
261+
262+
For more details, see the full documentation for [Code Owners](/product/issues/issue-owners/#code-owners).
263+
250264
### GitHub Single Sign-On
251265

252266
Single Sign-On (or SSO) allows you to manage your organization’s entire membership via a third-party provider.

src/docs/product/integrations/source-code-mgmt/gitlab/index.mdx

+13
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,19 @@ Stack trace linking takes you from a file in your Sentry stack trace to that sam
147147
1. If the file path in your Sentry stack trace frame doesn't match the path to your source code, you will need to replace the **stack_root** part of the file path with your **source_root** to make the file path match the source code path.
148148
* ex. For example, to get `src/code.py` to match `code.py` when the source code path is `https://gitlab.com/murdith-group/issa-project/-/blob/main/code.py`, change the **stack trace root** to be set as `src/`, and leave **source code root** empty.
149149

150+
### Code Owners
151+
152+
<Note>
153+
154+
This feature is available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony. If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
155+
156+
Let us know if you have feedback: [[email protected]](mailto:[email protected]).
157+
158+
</Note>
159+
160+
Import your existing GitLab CODEOWNERS files to automatically assign Sentry issues and route alerts to the responsible individuals and teams.
161+
162+
For more details, see the full documentation for [Code Owners](/product/issues/issue-owners/#code-owners).
150163

151164
## Troubleshooting
152165

Loading
Loading
Loading

src/docs/product/issues/issue-owners/index.mdx

+37
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,43 @@ You can also add a rule from the Issue Details page:
5858

5959
When you create a rule from the Issue Details page, you'll see some suggested paths and URLs based on the events in the issue. Note that [sentry.io](https://sentry.io) doesn't suggest tags.
6060

61+
### Code Owners
62+
63+
<Note>
64+
65+
This feature is available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony. If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
66+
67+
Let us know if you have feedback: [[email protected]](mailto:[email protected]).
68+
69+
</Note>
70+
71+
![Code Owners in UI](code_owners.png)
72+
73+
Import your CODEOWNERS file and use it alongside your Ownership Rules to assign Sentry issues. You can import and incrementally add the mappings between your source control teams/users to Sentry Teams/Users using [External Team/User Mappings](/product/issues/issue-owners/#external-teamuser-mappings). Sentry will automatically ignore rules that are missing team/user mappings.
74+
75+
This feature supports GitHub and GitLab CODEOWNERS file syntax with the following exceptions:
76+
- Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment
77+
- Using `!` to negate a pattern
78+
- Using `[ ]` to define a character range
79+
- [GitLab Premium syntax](https://docs.gitlab.com/ee/user/project/code_owners.html#code-owners-sections)
80+
- [GitHub CODEOWNERS syntax exceptions](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-code-owners#syntax-exceptions)
81+
82+
### External Team/User Mappings
83+
84+
<Note>
85+
86+
This feature is available only if you're in the Early Adopter program. Features available to Early Adopters are still in-progress and may have bugs. We recognize the irony. If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in General Settings. This will affect all users in your organization and can be turned back off just as easily.
87+
88+
Let us know if you have feedback: [[email protected]](mailto:[email protected]).
89+
90+
</Note>
91+
92+
![External team mappings for Github/Gitlab](external_team_mappings.png)
93+
94+
![External user mappings for Github/Gitlab](external_user_mappings.png)
95+
96+
Create external team/user mappings for your GitHub/GitLab teams and users by navigating to **Settings > Integrations > GitHub/GitLab > [Configuration] > Team Mappings/User Mappings**.
97+
6198
### Suggested Assignees
6299
63100
On the Issue Details page, you'll see suggested assignees based on ownership rules matching the event you're looking at (by default, the Issue Details page shows the latest event). Suggested assignees can also be based on [suspect commits](/product/releases/suspect-commits/). You can assign the _issue_ to a suggested assignee by clicking on the suggestion. An event can have multiple suggested assignees if it matches multiple ownership rules.

0 commit comments

Comments
 (0)