-
Notifications
You must be signed in to change notification settings - Fork 7
docs: add codeowner responsibilities #81
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
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5a704cc
docs: add codeowner responsibilities
ocofaigh 25d6e72
docs: README ToC updated from sidebar [skip ci]
terraform-ibm-modules-ops 596a9dd
Merge branch 'main' of github.com:terraform-ibm-modules/documentation…
ocofaigh 157f59e
extract internal
ocofaigh 94e26b3
Merge branch 'codeowner' of github.com:terraform-ibm-modules/document…
ocofaigh 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Code owners | ||
|
|
||
| Every repository in the [terraform-ibm-modules](https://github.com/terraform-ibm-modules/) GitHub organization must have a primary and secondary code owner. Code owner responsibilities include maintaining the code base, participating in pull request reviews, and taking action on incoming GitHub issues. | ||
|
|
||
| ## How to add / update repository code owners? | ||
|
|
||
| Code owners for a repository are stored in a file named `.github/CODEOWNERS`. The primary code owner should be listed first, followed by the secondary code owner. Below you will see the required format of the file where `primary-owner` and `secondary-owner` are the GitHub user names of the code owner users: | ||
|
|
||
| ``` | ||
| # Primary owner should be listed first in list of global owners, followed by any secondary owners | ||
| * @primary-owner @secondary-owner | ||
| ``` | ||
|
|
||
| It is also possible to break down the owners per directory. For example: | ||
ocofaigh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ``` | ||
| # Primary owner should be listed first in list of global owners, followed by any secondary owners | ||
| * @primary-owner @secondary-owner | ||
|
|
||
| # Order is important; the last matching pattern takes the most precedence. When someone opens a | ||
| # pull request that only modifies files in the below specified folders, only the listed owners | ||
| # and not the global owners will be requested for a review. | ||
| dev/ @dev-sre-user | ||
| stage/ @stage-sre-user | ||
| prod/ @prod-sre-user | ||
| ``` | ||
|
|
||
| For more information on the GitHub concept around code owners, see [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). | ||
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # Renovate | ||
|
|
||
| An IBM internal [Renovate](https://docs.renovatebot.com/) pipeline is run frequently against the repositories in the [terraform-ibm-modules](https://github.com/terraform-ibm-modules/) GitHub organization which will create pull requests to keep dependency versions at the latest. | ||
|
|
||
| Learn more about [How we use renovate to manage IaC dependencies](https://medium.com/@ocofaigh/how-we-use-renovate-to-manage-iac-dependencies-7584fb2ccc08). |
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.
Uh oh!
There was an error while loading. Please reload this page.