Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ You can see the published documentation at https://terraform-ibm-modules.github.
- [Adding your module to IBM Cloud](https://terraform-ibm-modules.github.io/documentation/#/onboard-ibm-cloud.md)
- Maintaining the GitHub project
- [Maintainers contribution process](https://terraform-ibm-modules.github.io/documentation/#/maintain-module.md)
- [Code owners](https://terraform-ibm-modules.github.io/documentation/#/codeowners.md)
- [About merging pull requests](https://terraform-ibm-modules.github.io/documentation/#/merging.md)
- [Renovate (Automated dependency updates)](https://terraform-ibm-modules.github.io/documentation/#/renovate.md)
- Reference
- [Module authoring guidelines](https://terraform-ibm-modules.github.io/documentation/#/implementation-guidelines.md)
- [DA authoring guidelines](https://terraform-ibm-modules.github.io/documentation/#/da-implementation-guidelines.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
- [Adding your module to IBM Cloud](onboard-ibm-cloud.md)
- Maintaining the GitHub project
- [Maintainers contribution process](maintain-module.md)
- [Code owners](codeowners.md)
- [About merging pull requests](merging.md)
- [Renovate (Automated dependency updates)](renovate.md)
- Reference
- [Module authoring guidelines](implementation-guidelines.md)
- [DA authoring guidelines](da-implementation-guidelines.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/codeowners.md
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:

```
# 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).
5 changes: 5 additions & 0 deletions docs/renovate.md
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).