Skip to content

Commit

Permalink
ci(release): Replace release script with git cliff
Browse files Browse the repository at this point in the history
  • Loading branch information
paulgessinger committed Jun 21, 2024
1 parent 3e75496 commit 00782c9
Show file tree
Hide file tree
Showing 6 changed files with 170 additions and 507 deletions.
19 changes: 14 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,23 @@ jobs:
uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5
with:
python-version: '3.8'

- run: pip install -r CI/release_requirements.txt
- name: Install git-cliff
run: |
curl -L https://github.com/orhun/git-cliff/releases/download/v2.3.0/git-cliff-2.3.0-x86_64-unknown-linux-musl.tar.gz > git-cliff.tar.gz
echo "3adde9625195825db9a59dd954fc90604172ba4b git-cliff.tar.gz" | shasum -c
mkdir git-cliff
tar xzf git-cliff.tar.gz --strip-components 1 --directory git-cliff
cp git-cliff /usr/local/bin/git-cliff
- name: Create release
env:
# for gh cli
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# for git-cliff
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
CI/release.py make-release
CI/release.sh
88 changes: 88 additions & 0 deletions CI/cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.

[changelog]
# changelog header
header = """
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
# {{ version | trim_start_matches(pat="v") }}
{% else %}\
# [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
## {{ group | striptags | trim | upper_first }}
{% for commit in commits %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %} 🚨 **BREAKING**: {% endif %}\
{{ commit.message | upper_first }}\
{% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
{% endfor %}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
"""
# remove the leading and trailing s
trim = true
# postprocessors
postprocessors = [
# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
]

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
# Replace issue numbers
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^build", group = "<!-- 7 --> 🛠️ Build" },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore|^ci", group = "<!-- 8 -->⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "<!-- 9 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 10 -->◀️ Revert" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
# tag_pattern = "v[0-9].*"
# regex for skipping tags
# skip_tags = ""
# regex for ignoring tags
# ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
# limit the number of commits included in the changelog.
# limit_commits = 42

[remote.github]
owner = "acts-project"
repo = "acts"
Loading

0 comments on commit 00782c9

Please sign in to comment.