ci: Render contributors in CHANGELOG.md (#592)

.github/workflows/run_release.yaml

@@ -139,7 +139,7 @@ jobs:
  run: pip install git-cliff
 
  - name: Generate release notes with git-cliff
- run: git-cliff --tag "v${{ needs.should_release.outputs.version_number }}" --unreleased --strip all > release_notes.md
+ run: git-cliff --tag "v${{ needs.should_release.outputs.version_number }}" --unreleased --strip all --config cliff_release.toml > release_notes.md
 
  - name: Create release
  uses: softprops/action-gh-release@v2

cliff_release.toml

@@ -0,0 +1,102 @@
+# 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 = """
+# 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") }}](<REPO>/releases/tag/{{ version }}) ({{ timestamp | date(format="%Y-%m-%d") }})
+{% elif message %}\
+ ## {{ message | trim_start_matches(pat="v") }} - **not yet released**
+{% 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 }} ([{{ commit.id | truncate(length = 7, end = "") }}](<REPO>/commit/{{ commit.id }}))\
+ {% if commit.github.username %} by @{{ commit.github.username }}{% endif %}
+ {% 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:/apify/crawlee-python" }, # replace repository URL
+]
+
+[bump]
+# With 0.x.y version, breaking commits should only increase the minor version and feature commits should only increase the patch version
+breaking_always_bump_major = false
+features_always_bump_minor = false
+
+[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 PR and issue numbers in commit messages
+ { pattern = '.*', replace_command = 'python scripts/preprocess_commit_message.py'},
+ # Check spelling of the commit with https:/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|^bug", group = "<!-- 1 -->🐛 Bug Fixes" },
+ # { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+ { message = "^doc", skip = true },
+ { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+ # { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+ { message = "^refactor", skip = true },
+ # { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+ { message = "^style", skip = true },
+ # { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+ { message = "^test", skip = true },
+ { message = "^chore\\(release\\): prepare for", skip = true },
+ { message = "^chore\\(deps.*\\)", skip = true },
+ { message = "^chore\\(pr\\)", skip = true },
+ { message = "^chore\\(pull\\)", skip = true },
+ # { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+ { message = "^chore|^ci", skip = true },
+ { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+ { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = true
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "v[0-9]+\\."
+# 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 = "apify"
+repo = "crawlee-python"