diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c1078b6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Changelog + +All notable changes to this project will be documented in this file. + + +## [v0.3.3](https://code.thetadev.de/ThetaDev/bandcamp/compare/v0.3.2..v0.3.3) - 2024-11-15 + +### ⚙️ Miscellaneous Tasks + +- Update thiserror to v2 - ([37ff50e](https://code.thetadev.de/ThetaDev/bandcamp/commit/37ff50ec7ad99dafc7765764d9a37512c0d0b225)) +- Add changelog - ([d94c691](https://code.thetadev.de/ThetaDev/bandcamp/commit/d94c691b1d682cfbea7272718b3829795c477edf)) + +## [v0.3.2](https://code.thetadev.de/ThetaDev/bandcamp/commits/tag/v0.3.2) - 2024-08-19 + +Initial release + + diff --git a/Cargo.toml b/Cargo.toml index a9dcbcd..2860a04 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bandcamp" -version = "0.3.2" +version = "0.3.3" edition = "2021" authors = ["ThetaDev "] license = "MIT" diff --git a/Justfile b/Justfile new file mode 100644 index 0000000..dfea036 --- /dev/null +++ b/Justfile @@ -0,0 +1,32 @@ +test: + cargo test + +release: + #!/usr/bin/env bash + set -e + + CRATE="bandcamp" + CHANGELOG="CHANGELOG.md" + + VERSION=$(cargo pkgid --package "$CRATE" | tr '#@' '\n' | tail -n 1) + TAG="v${VERSION}" + echo "Releasing $TAG:" + + if git rev-parse "$TAG" >/dev/null 2>&1; then echo "version tag $TAG already exists"; exit 1; fi + + CLIFF_ARGS="--tag '${TAG}' --unreleased" + echo "git-cliff $CLIFF_ARGS" + if [ -f "$CHANGELOG" ]; then + eval "git-cliff $CLIFF_ARGS --prepend '$CHANGELOG'" + else + eval "git-cliff $CLIFF_ARGS --output '$CHANGELOG'" + fi + + editor "$CHANGELOG" + + git add . + git commit -m "chore(release): release $CRATE v$VERSION" + + awk 'BEGIN{RS="(^|\n)## [^\n]+\n*"} NR==2 { print }' "$CHANGELOG" | git tag -as -F - --cleanup whitespace "$TAG" + + echo "🚀 Run 'git push origin $TAG' to publish" diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..8ab276e --- /dev/null +++ b/cliff.toml @@ -0,0 +1,100 @@ +# 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 = """ +{% set repo_url = "https://code.thetadev.de/ThetaDev/bandcamp" %}\ +{% if version %}\ + {%set vname = version | split(pat="/") | last %} + {%if previous.version %}\ + ## [{{ vname }}]({{ repo_url }}/compare/{{ previous.version }}..{{ version }})\ + {% else %}\ + ## [{{ vname }}]({{ repo_url }}/commits/tag/{{ version }})\ + {% endif %} - {{ timestamp | date(format="%Y-%m-%d") }} +{% else %}\ + ## [unreleased] +{% endif %}\ +{% if previous.version %}\ +{% 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_url }}/commit/{{ commit.id }}))\ + {% endfor %} +{% endfor %}\ +{% else %} +Initial release +{% endif %}\n +""" +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing s +trim = true +# postprocessors +postprocessors = [ + # { pattern = '', 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}](/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 = "🚀 Features" }, + { message = "^fix", group = "🐛 Bug Fixes" }, + { message = "^doc", group = "📚 Documentation" }, + { message = "^perf", group = "⚡ Performance" }, + { message = "^refactor", group = "🚜 Refactor" }, + { message = "^style", group = "🎨 Styling" }, + { message = "^test", skip = true }, + { message = "^chore\\(release\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^chore", group = "⚙️ Miscellaneous Tasks" }, + { message = "^ci", skip = true }, + { body = ".*security", group = "🛡️ Security" }, + { message = "^revert", group = "◀️ 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