Skip to content

Commit

Permalink
👷 chore(release): improve release script
Browse files Browse the repository at this point in the history
  • Loading branch information
welpo committed Jan 19, 2024
1 parent 8d5d6bc commit 124c31e
Showing 1 changed file with 17 additions and 37 deletions.
54 changes: 17 additions & 37 deletions release
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/env bash
# Bash script to prepare a release using git-cliff.
# Inspired by https://github.com/orhun/git-cliff/blob/main/release.sh
set -eu

# Check if a version tag is provided.
if [ "$#" -eq 1 ]; then
Expand Down Expand Up @@ -47,19 +48,12 @@ export GIT_CLIFF_TEMPLATE="\
{%- endfor %}
{% endfor %}"

# Create a temporary file for the git-cliff configuration.
# It's the same as the one in cliff.toml, except less Markdown.
temp_cliff_config=$(mktemp)
# Set a trap to remove the temporary file on exit.
trap "rm -f '$temp_cliff_config'" EXIT

cat > "$temp_cliff_config" << 'EOF'
[changelog]
body = """
# Cleaner template for the tag description.
export GIT_CLIFF__CHANGELOG__BODY=$(cat <<'EOF'
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
## unreleased
{% endif %}\
{% macro commit(commit, in_breaking_section=false) -%}
Expand Down Expand Up @@ -95,36 +89,22 @@ body = """
{% endif -%}
{% endfor -%}
{% endfor %}\n
"""
trim = true
footer = """
<!-- generated by git-cliff -->
"""
[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_preprocessors = [
{ pattern = ' +$', replace = "" },
{ pattern = ' +', replace = " " },
{ pattern = ' *(:\w+:|[\p{Emoji_Presentation}\p{Extended_Pictographic}\u{200D}]) *', replace = "" },
]
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->✨ Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
[truncated for brevity]...
]
protect_breaking_commits = true
filter_commits = true
tag_pattern = "v[0-9].*"
topo_order = false
sort_commits = "newest"
EOF
)

# Same as cliff.toml, except we don't replace issue number with a link (which aren't clickable on tag descriptions).
export GIT_CLIFF__GIT__PREPROCESSORS=$(cat <<'EOF'
# Remove trailing whitespace.
{ pattern = ' +$', replace = "" },
# Replace multiple spaces with a single space.
{ pattern = ' +', replace = " " },
# Remove gitmoji, both actual UTF emoji and :emoji:
{ pattern = ' *(:\w+:|[\p{Emoji_Presentation}\p{Extended_Pictographic}\u{200D}]) *', replace = "" }
EOF
)

# Generate the tag description.
changelog=$(git cliff --config "$temp_cliff_config" --tag "$VERSION_TAG" --unreleased --strip all)
changelog=$(git cliff --tag "$VERSION_TAG" --unreleased --strip all)

# Create a signed and annotated tag.
git tag -s -a "$VERSION_TAG" -m "Release $VERSION_TAG" -m "$changelog"
Expand Down

0 comments on commit 124c31e

Please sign in to comment.