-
Notifications
You must be signed in to change notification settings - Fork 1
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
Docs: Explain GitHub App needs access to each repo #32
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,11 @@ | ||
# Organisation Setup | ||
|
||
These instructions are the initial setup for an organisation that's going to use `gha-scala-library-release-workflow`. | ||
These steps are the initial setup for an organisation that's going to use `gha-scala-library-release-workflow`. | ||
When we say "organisation", we mean a GitHub organisation (like [github.com/guardian](https://github.com/guardian)), but | ||
these instructions more or less also apply to a single GitHub user account, if you want to set up your own personal | ||
repos to use this workflow. | ||
these instructions also apply to a single GitHub user account, if you want to set up your own personal | ||
repos to use the workflow. | ||
|
||
## 1. Set up the GitHub App | ||
|
||
See [Setting up the GitHub App](github-app.md) for details on how to create the necessary GitHub App. | ||
|
||
## 2. Create credentials | ||
|
||
See [Generating new credentials](credentials/generating-credentials.md) for details on how to create the necessary | ||
credentials, and [Supplying credentials](credentials/supplying-credentials.md) for how to store and supply them to | ||
your repos. | ||
|
||
## 3. Configure repos to use the release workflow | ||
|
||
See [Configuration](configuration.md) for details on how to configure your repos to use the release workflow. | ||
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. | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These changes are just making this page a bit more concise!