Skip to content
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

Add renovatebot as a dependency management option #271

Merged
merged 7 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from 6 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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

- Require a CLA Assistant GitHub workflow. (#269)
- Update the CLA notice in `CONTRIBUTING.md` template. (#269)
- Add Renovate as an acceptable alternative to Dependabot (#271)
pellared marked this conversation as resolved.
Show resolved Hide resolved

## [1.6.0] - 2023-09-14

Expand Down
14 changes: 14 additions & 0 deletions specification/repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,25 @@ approval is granted, GDI repositories MUST NOT cut a GA release.
- MUST lock the versions of all build dependencies (e.g. libraries, binaries,
scripts, docker images) or vendor them; **EXCEPTION:** tools that are
available out-of-the-box on the CI runner
- To help keep dependencies up to date, the repo MUST be configured with
[Dependabot](https://github.com/dependabot/dependabot-core) or [Renovate](https://github.com/apps/renovate).

#### Dependabot

- MUST enable [Dependabot alerts](https://docs.github.com/en/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)
- MUST grant access to alerts for the approvers and maintainers teams
- MUST enable [Dependabot security updates](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)
- MUST configure [Dependabot version updates](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)

#### Renovate
pellared marked this conversation as resolved.
Show resolved Hide resolved

breedx-splk marked this conversation as resolved.
Show resolved Hide resolved
Follow the steps below if you want to use Renovate to update the dependencies.

- MUST add the repo to the [list of Renovatebot repos](https://github.com/organizations/signalfx/settings/installations/41531652).
- MUST add a
[Renovate config file](https://docs.renovatebot.com/configuration-options/)
to the repo.

### GitHub Actions

- MUST use [GitHub
Expand Down