Docs: Explain GitHub App needs access to each repo #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Following on from #26, which introduced the need to have a GitHub App, this updates the docs further to explain that the GitHub App must be granted access to each repo that it acts upon. If the GitHub App does not have access to the repo, the release flow will fail, like https://github.com/guardian/content-entity/actions/runs/8347150774 : > Maven Release / 🔒 Push Release Commit > Not Found - https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app
rtyley
commented
Mar 19, 2024
Comment on lines
+8
to
+11
| 1. [Create the GitHub App](github-app.md) to perform actions on your repos, like pushing commits and making PR comments. | ||
| 2. [Generate release credentials](credentials/generating-credentials.md) (ie Sonatype account, PGP key, etc) and | ||
| get ready to [supply them to the workflow](credentials/supplying-credentials.md). | ||
| 3. [Configure your repos](configuration.md) to use the release workflow. |
There was a problem hiding this comment.
These changes are just making this page a bit more concise!
|
I followed these instructions for adding 
|
|
As in demonstrated in the comment above, @Divs-B was kind enough to verify that she could grant the gu-scala-library-release GitHub App access to selected repositories, so long as she was an admin on those repos - you don't need any more elevated permission than that (eg, she was not an App manager or Organisation owner). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following on from #26, which introduced the need to have a GitHub App, this updates the docs further to explain that the GitHub App must be granted access to each repo that it acts upon.
If the GitHub App does not have access to the repo, the release flow will fail: