From ebb2c1de9c90071d65a9b26c8deab0406b7b7d7b Mon Sep 17 00:00:00 2001 From: Gustavo Carreno Date: Tue, 3 Dec 2024 18:39:21 +0000 Subject: [PATCH] feat: Adding `CI`/`CD` --- .github/workflows/main.yaml | 71 +++++++++++++++++++++++++++++++ cliff.toml | 85 +++++++++++++++++++++++++++++++++++++ 2 files changed, 156 insertions(+) create mode 100644 .github/workflows/main.yaml create mode 100644 cliff.toml diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml new file mode 100644 index 0000000..a4b9f4d --- /dev/null +++ b/.github/workflows/main.yaml @@ -0,0 +1,71 @@ +name: PasIRCLogBot + +permissions: + contents: write + +on: + + push: + branches: [ main ] + tags: [ "*" ] + paths-ignore: [ "README.md", "LICENSE", "CHANGELOG.md", "cliff.toml" ] + + pull_request: + branches: [ main ] + +jobs: + + build: + name: 01 - Build Application + uses: gcarreno/re-usable-workflows/.github/workflows/build.lazarus.yml@main + with: + config: '{ + "app-name": "paslogbot", + "lpi-path": "src", + "bin-path": "bin", + "build-mode": "Release", + "lazarus-packages": "", + "matrix": { + "os": [ + "ubuntu-latest", + "windows-latest", + "macos-latest" + ], + "include":[ + { + "os": "ubuntu-latest", + "triplet": "x86_64-linux" + }, + { + "os": "windows-latest", + "triplet": "x86_64-win64" + }, + { + "os": "macos-latest", + "triplet": "x86_64-darwin" + } + ], + "lazarus-versions": [ + "stable", + "3.4" + ] + } + }' + fail-fast: false + + release: + if: contains(github.ref_type, 'tag') + + name: 02 - Create GitHub Release + uses: gcarreno/re-usable-workflows/.github/workflows/release.lazarus.yml@main + needs: [ build] + with: + config: '{ + "app-name": "paslogbot", + "tag": "${{ github.ref_name }}", + "cliff-cfg": "cliff.toml", + "win": "${{ needs.build.outputs.win-artefact-path }}", + "lin": "${{ needs.build.outputs.lin-artefact-path }}", + "osx": "${{ needs.build.outputs.osx-artefact-path }}" + }' + fail-fast: false diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..aae4cc1 --- /dev/null +++ b/cliff.toml @@ -0,0 +1,85 @@ +# 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 = """ +# Release Notes\n +Notable changes up to the last release.\n +\n +""" +# template for the changelog body +# https://tera.netlify.app/docs +body = """ +{% if version %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} +{% else %}\ + ## [unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | upper_first }} + {% for commit in commits %} + - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ + {% endfor %} +{% endfor %}\n +""" +# remove the leading and trailing whitespace from the template +trim = true +# changelog footer +footer = """ +For a list of all the changes up to date, please read [CHANGELOG.md](https://github.com/ObjectPascal-Community/pasirclogbot/blob/main/CHANGELOG.md). + +""" +# postprocessors +postprocessors = [ + # { pattern = '', replace = "https://github.com/ObjectPascal-Community/pasirclogbot" }, # 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 = [ + # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](/issues/${2}))"}, # replace issue numbers +] +# 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", group = "Testing" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(deps\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^ign", skip = true}, + { message = "^chore|ci", group = "Miscellaneous Tasks" }, + { 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 +# glob pattern for matching git tags +tag_pattern = "v[0-9]*" +# regex for skipping tags +skip_tags = "v0.1.0-beta.1" +# 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