Skip to content

Commit

Permalink
docs: add renovate usage and template
Browse files Browse the repository at this point in the history
fix #38
  • Loading branch information
esoubiran-aneo committed Jun 23, 2023
1 parent 29abc63 commit 66c4837
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions content/1.guide/8.update.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,47 @@ Find more information about [`taze`](https://www.npmjs.com/package/taze).
## Automatic Update

To enable automatic update, you can use [Renovate](https://renovatebot.com/) or [Dependabot](https://dependabot.com/).

In ArmoniK, we use Renovate. Here's our configuration for a repo with a `.docs` folder:

```json [renovate.json]
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base",
"group:allNonMajor",
":semanticCommitTypeAll(chore)",
"helpers:pinGitHubActionDigests"
],
"rangeStrategy": "bump",
"packageRules": [
{
"groupName": "docs npm packages",
"groupSlug": "docs-npm",
"matchPaths": [
".docs/**"
],
"matchDatasources": [
"npm"
]
},
{
"groupName": "github actions",
"groupSlug": "github-actions",
"matchDatasources": [
"github-tags"
]
},
]
}
```

We group all non-major updates in a single PR and we use semantic commit type `chore` for all commits.

We pin GitHub Actions digests to avoid breaking changes or security issues in our workflows.

We group npm packages found in the documentation and GitHub Actions in two different PRs to avoid conflicts.

::alert{type="info"}
Grouping npm packages from documentation in a single PR is used to avoid grouping npm packages from the project in the same PR.
::

0 comments on commit 66c4837

Please sign in to comment.