Skip to content

Commit

Permalink
ARC-1766 create branch permissions (#1706)
Browse files Browse the repository at this point in the history
* ARC-1766 contents write perms

* ARC-1766 contents write perms

* on your request added to docs for clarity

Co-authored-by: Josh Kay <joshk@atlassian.com>
  • Loading branch information
joshkay10 and Josh Kay authored Nov 3, 2022
1 parent 3c78416 commit 32cfa6a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Your new GitHub app will need the following repository permissions & events:
**Repository Permissions**:
+ Actions: Read-only
+ Code scanning alerts: Read-only
+ Contents: Read-only
+ Contents: Read & Write
+ Deployments: Read-only
+ Issues: Read & write
+ Metadata: Read-only
Expand Down
4 changes: 2 additions & 2 deletions docs/FAQs.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ When an organization contains a small amount of data, the backfilling process is

![Edit GitHub settings](./images/edit-github-settings.png)

<h3>Q: What about pull requests and issues? I noticed I need to grant read and write permissions. Why is this needed?</h3>
<h3>Q: What about pull requests, contents and issues? I noticed I need to grant read and write permissions. Why is this needed?</h3>

**A:** This is needed so our app can create links to Jira issues from pull request or issue comments. When you create a comment and include the issue key surrounded by square brackets, our app while ping Jira to see if that issue key exists in a project in Jira and, if it finds a matching issue, will create a link for easy navigation.
**A:** This is needed so our app can create links to Jira issues from pull request or issue comments. When you create a comment and include the issue key surrounded by square brackets, our app while ping Jira to see if that issue key exists in a project in Jira and, if it finds a matching issue, will create a link for easy navigation. As for contents, we need the write access so we can create a branch on your request.

![Pull request and issue comment links](./images/read-and-write-permissions-issues-and-prs.png)

Expand Down

0 comments on commit 32cfa6a

Please sign in to comment.