From 989ba8642fcc9598e945d0838407d4568d1d791e Mon Sep 17 00:00:00 2001 From: Aram <37216945+alimpens@users.noreply.github.com> Date: Fri, 1 Dec 2023 13:29:41 +0100 Subject: [PATCH] chore: Finetune automatic changelogs (#840) Co-authored-by: Vincent Smedinga --- .github/dependabot.yml | 7 +++++++ .github/workflows/pr-title-validation.yml | 5 +++++ documentation/publishing.md | 11 ++++++++++- lerna.json | 1 + 4 files changed, 23 insertions(+), 1 deletion(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index fc6b44a6c3..c6ca9c7ae0 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -7,9 +7,16 @@ updates: directory: "/" schedule: interval: "weekly" + commit-message: + prefix: chore + include: scope - package-ecosystem: "npm" directory: "/" schedule: interval: "daily" versioning-strategy: "increase-if-necessary" open-pull-requests-limit: 20 + commit-message: + prefix: fix + prefix-development: chore + include: scope diff --git a/.github/workflows/pr-title-validation.yml b/.github/workflows/pr-title-validation.yml index 0e7b7c3232..de8a9e6a9e 100644 --- a/.github/workflows/pr-title-validation.yml +++ b/.github/workflows/pr-title-validation.yml @@ -20,3 +20,8 @@ jobs: - uses: amannn/action-semantic-pull-request@v5 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + types: | + fix + feat + chore diff --git a/documentation/publishing.md b/documentation/publishing.md index 4c8b1f3fe5..3694d39a9a 100644 --- a/documentation/publishing.md +++ b/documentation/publishing.md @@ -8,7 +8,16 @@ If you want to have rights to publish as well, contact one of the [maintainers]( ## Conventional commits In order to know whether a release is major, minor or patch and to automatically generate changelogs, we use the [conventional commits spec](https://www.conventionalcommits.org/en/v1.0.0/). -In our PR titles, we specify whether a change is a patch, a fix (minor) or a breaking change (major). +The titles of our PRs specify whether a change is: + +- a `chore`, which doesn’t trigger a release +- a `fix`, resulting in a patch release, +- a new feature (`feat`), a minor release, or +- a breaking change (`feat!`), a major release. + +Use the `chore` prefix when updating development dependencies, changing configuration or updating documentation which isn't about a component. +For refactors, regular dependency updates or updates to documentation about components, use the `fix` prefix. + The PR title also describes the change in a clear, human-friendly way. This PR title becomes the description of a commit when we squash merge a feature branch PR into `develop`. These commit descriptions are eventually used to figure out the release type and to generate entries into our changelogs. diff --git a/lerna.json b/lerna.json index 3a6d0503d0..c92cc964b0 100644 --- a/lerna.json +++ b/lerna.json @@ -14,6 +14,7 @@ "conventionalCommits": true, "exact": true, "private": false, + "skipBumpOnlyReleases": true, "syncWorkspaceLock": true } }