Skip to content

Commit

Permalink
[ignore] Testing git-cliff in GitHub actions
Browse files Browse the repository at this point in the history
  • Loading branch information
samiib committed Jul 13, 2024
1 parent bd77190 commit ba7168d
Show file tree
Hide file tree
Showing 2 changed files with 112 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/workflows/release_pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: release_pr

on:
push:
branches:
- release-pr-test

jobs:
git-cliff:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Unshallow
run: git fetch --prune --unshallow

- uses: actions/setup-python@v5
with:
python-version: '3.10'

- run: pip install git-cliff

- name: Generate changelog output
run: git cliff --bump --unreleased

- name: Prepend new changelog entry
run: git cliff --bump --unreleased -p CHANGELOG.md

- name: Set git config
run: git config user.email "[email protected]" && git config user.name "dcn-ecosystem"

- name: Commit
run: git add -u && git status && git commit -m "[ignore] Update Changelog for new release (vTODO)"
78 changes: 78 additions & 0 deletions cliff.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# git-cliff ~ 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]
# template for the changelog footer
header = """
# Terraform Provider ACI - Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
## {{ version | trim_start_matches(pat="v") }} ({{ timestamp | date(format="%B %d, %Y") }})
{% else %}\
## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
{{ group | striptags | trim | upper_first }}:
{% for commit in commits -%}
- {{ commit.message | trim_start_matches(pat="[bugfix]") | trim }}
{% endfor -%}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# 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 = false
# 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 = "[D|d]eprecat", group = "<!-- 0 -->DEPRECATIONS" },
{ message = "^.bug", group = "<!-- 1 -->BUG FIXES" },
{ message = "^.minor", group = "<!-- 3 -->IMPROVEMENTS" },
{ message = "^.major", group = "<!-- 3 -->IMPROVEMENTS" },
# { message = ".*", group = "<!-- 5 -->OTHER" },
]
# 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

0 comments on commit ba7168d

Please sign in to comment.