Skip to content

Commit

Permalink
chore(ci): Inline cliff config into release-plz toml (#1571)
Browse files Browse the repository at this point in the history
Mini-chore: drop the cliff config file, and use inline changelog
configuration for release-plz, as recommended by their docs. I'm just
copying the config used for `tket2`.

`release-plz` only parses the cliff config as backward-compatibility,
the configs have diverged sightly since we wrote this `cliff.toml`.
  • Loading branch information
aborgna-q authored Oct 11, 2024
1 parent 8227387 commit 2f7d02c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 76 deletions.
73 changes: 0 additions & 73 deletions cliff.toml

This file was deleted.

20 changes: 17 additions & 3 deletions release-plz.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ release = false
# Open the release PR as a draft
pr_draft = true

# Use a custom git-cliff configuration
changelog_config = "cliff.toml"

# Enforce adding the project name in the git tag, to avoid collisions with python.
# (This would normally only be enabled once there are multiple packages in the workspace)
git_tag_name = "{{ package }}-v{{ version }}"
Expand All @@ -22,6 +19,23 @@ git_release_name = "{{ package }}: v{{ version }}"
# To trigger a release manually, merge a PR from a branch starting with `release-plz-`.
release_always = false

[changelog]
sort_commits = "oldest"

# Allowed conventional commit types
commit_parsers = [
{ message = "^feat", group = "New Features" },
{ message = "^fix", group = "Bug Fixes" },
{ message = "^docs", group = "Documentation" },
{ message = "^style", group = "Styling" },
{ message = "^refactor", group = "Refactor" },
{ message = "^perf", group = "Performance" },
{ message = "^test", group = "Testing" },
{ message = "^chore", group = "Miscellaneous Tasks", skip = true },
{ message = "^revert", group = "Reverted changes", skip = true },
{ message = "^ci", group = "CI", skip = true },
]

[[package]]
name = "hugr"
changelog_include = ["hugr-core", "hugr-passes"]
Expand Down

0 comments on commit 2f7d02c

Please sign in to comment.