Skip to content

Commit b2df377

Browse files
authored
docs: add codeowner responsibilities (#81)
1 parent 9ed93d6 commit b2df377

File tree

4 files changed

+37
-0
lines changed

4 files changed

+37
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ You can see the published documentation at https://terraform-ibm-modules.github.
2020
- [Adding your module to IBM Cloud](https://terraform-ibm-modules.github.io/documentation/#/onboard-ibm-cloud.md)
2121
- Maintaining the GitHub project
2222
- [Maintainers contribution process](https://terraform-ibm-modules.github.io/documentation/#/maintain-module.md)
23+
- [Code owners](https://terraform-ibm-modules.github.io/documentation/#/codeowners.md)
2324
- [About merging pull requests](https://terraform-ibm-modules.github.io/documentation/#/merging.md)
25+
- [Renovate (Automated dependency updates)](https://terraform-ibm-modules.github.io/documentation/#/renovate.md)
2426
- Reference
2527
- [Module authoring guidelines](https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines.md)
2628
- [DA authoring guidelines](https://terraform-ibm-modules.github.io/documentation/#/da-implementation-guidelines.md)

docs/_sidebar.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
- [Adding your module to IBM Cloud](onboard-ibm-cloud.md)
1111
- Maintaining the GitHub project
1212
- [Maintainers contribution process](maintain-module.md)
13+
- [Code owners](codeowners.md)
1314
- [About merging pull requests](merging.md)
15+
- [Renovate (Automated dependency updates)](renovate.md)
1416
- Reference
1517
- [Module authoring guidelines](implementation-guidelines.md)
1618
- [DA authoring guidelines](da-implementation-guidelines.md)

docs/codeowners.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Code owners
2+
3+
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.
4+
5+
## How to add / update repository code owners?
6+
7+
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:
8+
9+
```
10+
# Primary owner should be listed first in list of global owners, followed by any secondary owners
11+
* @primary-owner @secondary-owner
12+
```
13+
14+
It is also possible to break down the owners per directory. For example:
15+
16+
```
17+
# Primary owner should be listed first in list of global owners, followed by any secondary owners
18+
* @primary-owner @secondary-owner
19+
20+
# Order is important; the last matching pattern takes the most precedence. When someone opens a
21+
# pull request that only modifies files in the below specified folders, only the listed owners
22+
# and not the global owners will be requested for a review.
23+
dev/ @dev-sre-user
24+
stage/ @stage-sre-user
25+
prod/ @prod-sre-user
26+
```
27+
28+
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).

docs/renovate.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Renovate
2+
3+
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.
4+
5+
Learn more about [How we use renovate to manage IaC dependencies](https://medium.com/@ocofaigh/how-we-use-renovate-to-manage-iac-dependencies-7584fb2ccc08).

0 commit comments

Comments
 (0)