From a7a0295a3cf06759aafc4f756ab963fde0535af9 Mon Sep 17 00:00:00 2001 From: Ryan Parman Date: Tue, 26 Mar 2024 16:42:13 -0600 Subject: [PATCH] docs: Enable generation of CHANGELOG. --- .github/workflows/update-on-push.yml | 14 +-- CHANGELOG.md | 45 +++++++++ cliff.toml | 134 +++++++++++++-------------- 3 files changed, 119 insertions(+), 74 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.github/workflows/update-on-push.yml b/.github/workflows/update-on-push.yml index d68f1f5..adc4a06 100644 --- a/.github/workflows/update-on-push.yml +++ b/.github/workflows/update-on-push.yml @@ -39,13 +39,13 @@ jobs: with: fetch-depth: 0 - # - name: Generate Changelog - # uses: orhun/git-cliff-action@8b17108aad4d9362649a5dae020746c2a767c90d # v3.0.2 - # with: - # config: cliff.toml - # args: --verbose - # env: - # OUTPUT: CHANGELOG.md + - name: Generate Changelog + uses: orhun/git-cliff-action@8b17108aad4d9362649a5dae020746c2a767c90d # v3.0.2 + with: + config: cliff.toml + args: --verbose + env: + OUTPUT: CHANGELOG.md - name: Generate artifacts run: | diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..5308f40 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,45 @@ +# CHANGELOG + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com), adheres to [Semantic Versioning](https://semver.org), and uses [Conventional Commit](https://www.conventionalcommits.org) syntax. + +## Unreleased + +### :books: Documentation + +* [`5b06ed4`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/5b06ed48418bc103e2d968f84a3b74142e5930a2): Generate documentation in `README.md` ([@github-actions](https://github.com/github-actions)) +* [`5ef20f9`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/5ef20f96f363e3cc07419fe0e696c3eeb09929a4): Updated the 'sales pitch' in the `README.md`. ([@skyzyx](https://github.com/skyzyx)) +* [`7021bb1`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/7021bb173db4e28439754175c4498806f20aa321): Generate documentation in `README.md` ([@github-actions](https://github.com/github-actions)) + +### :dependabot: Building and Dependencies + +* [`efaa652`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/efaa6521a47980f216d9af91a2969878a1d51b57): Bump `actions/dependency-review-action` from 4.2.4 to 4.2.5 ([#1](https://github.com/northwood-labs/mod-aws-resource-tags/issues/1)) ([@dependabot](https://github.com/dependabot)) + +### :test_tube: Testing + +* [`fd1b704`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/fd1b7046f98c498ec85da0f8f8ca79c49f8d8cd4): Update testing script. ([@skyzyx](https://github.com/skyzyx)) +* [`48c3d4e`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/48c3d4e15ad458416f7804de6d0d4d52680f10df): Update hardening to allow EC2 endpoints. ([@skyzyx](https://github.com/skyzyx)) +* [`988a2b0`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/988a2b0826d7282018bb237266d03d7e458296cf): Add Trivy security scan. ([@skyzyx](https://github.com/skyzyx)) +* [`5d8993f`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/5d8993f522ac05b869c8adde74657d97930dc859): Allow Trivy scan to contact ghcr.io. ([@skyzyx](https://github.com/skyzyx)) +* [`a3264a4`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/a3264a4ea499a3566834ee37d5df9d3ae1135f2d): Allow Trivy scan to contact pkg-containers.githubusercontent.com. ([@skyzyx](https://github.com/skyzyx)) +* [`5ac2f2c`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/5ac2f2cbbd2375464d2d87bda266bcb5e112b393): Update hardening for Markdownlint and Terraform-Docs. ([@skyzyx](https://github.com/skyzyx)) +* [`737f0ec`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/737f0ec6fa0520fcc6a6c8c068c701ab8345710b): Add Trivy license scan. ([@skyzyx](https://github.com/skyzyx)) + +### :tractor: Refactor + +* [`1016c5e`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/1016c5e7cf5666b24ff226d81f0b5c0470e643f9): Tweaked the naming of some of the resources. ([@skyzyx](https://github.com/skyzyx)) + +### :rocket: Features + +* [`5503847`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/55038470a1bd87a2c9f6568ca05ece18593bc349): Initial commit ([@skyzyx](https://github.com/skyzyx)) + +### :bug: Bug Fixes + +* [`996dc1d`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/996dc1d4fe61bb6c53c5dd769961c913e551e5be): First working version. ([@skyzyx](https://github.com/skyzyx)) + +### :gear: Miscellaneous Tasks + +* [`a2f5a7c`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/a2f5a7cf10ab6c684ea640baa8d27b457373e760): Harden GitHub Actions ([#2](https://github.com/northwood-labs/mod-aws-resource-tags/issues/2)) ([@step-security-bot](https://github.com/step-security-bot)) + +

Generated on 2024-03-26.

diff --git a/cliff.toml b/cliff.toml index 7164056..eb520e6 100644 --- a/cliff.toml +++ b/cliff.toml @@ -7,12 +7,12 @@ [remote.github] owner = "northwood-labs" - repo = "terraform-provider-corefunc" + repo = "mod-aws-networking" # token = "" # Use GITHUB_TOKEN environment variable instead. # goplicate-start:changelog [changelog] -header = """ + header = """ # CHANGELOG All notable changes to this project will be documented in this file. @@ -20,9 +20,9 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com), adheres to [Semantic Versioning](https://semver.org), and uses [Conventional Commit](https://www.conventionalcommits.org) syntax. """ -# template for the changelog body -# https://keats.github.io/tera/docs/#introduction -body = """ + # template for the changelog body + # https://keats.github.io/tera/docs/#introduction + body = """ {% if version %} ## {{ version | trim_start_matches(pat="v") }} — {{ timestamp | date(format="%Y-%m-%d") }} {% if previous.version %} @@ -49,15 +49,15 @@ body = """ {%- endmacro -%} """ -# remove the leading and trailing whitespace from the template -trim = true + # remove the leading and trailing whitespace from the template + trim = true -# changelog footer -footer = """ + # changelog footer + footer = """

Generated on {{ now() | date(format="%Y-%m-%d") }}.

""" -# goplicate-end:changelog + # goplicate-end:changelog postprocessors = [ { pattern = "linrinf", replace = "linting" }, @@ -78,60 +78,60 @@ footer = """ # goplicate-start:git [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 = ":rocket: Features" }, - { message = "^fix", group = ":bug: Bug Fixes" }, - { message = "^perf", group = ":racecar: Performance" }, - { message = "^docs", group = ":books: Documentation" }, - { message = "^refactor", group = ":tractor: Refactor" }, - { message = "^style", group = ":art: Styling" }, - { message = "^build|deps", group = ":dependabot: Building and Dependencies" }, - { message = "^test", group = ":test_tube: Testing" }, - { message = "^lint", group = ":soap: Linting" }, - { message = "^chore\\(release\\): prepare for", skip = true }, - { message = "^chore\\(deps\\)", skip = true }, - { message = "^chore\\(pr\\)", skip = true }, - { message = "^chore\\(pull\\)", skip = true }, - { message = "^relprep", skip = true }, - { message = "^chore|ci", group = ":gear: Miscellaneous Tasks" }, - { body = ".*security", group = ":closed_lock_with_key: Security" }, - { message = "^revert", group = ":x: Revert" }, - { message = "^automation", skip = true }, -] - -# 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 = "beta|alpha" - -# regex for ignoring tags -ignore_tags = "rc" - -# sort the tags topologically -topo_order = true - -# sort the commits inside sections by oldest/newest order -sort_commits = "oldest" -# goplicate-end: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 = ":rocket: Features" }, + { message = "^fix", group = ":bug: Bug Fixes" }, + { message = "^perf", group = ":racecar: Performance" }, + { message = "^docs", group = ":books: Documentation" }, + { message = "^refactor", group = ":tractor: Refactor" }, + { message = "^style", group = ":art: Styling" }, + { message = "^build|deps", group = ":dependabot: Building and Dependencies" }, + { message = "^test", group = ":test_tube: Testing" }, + { message = "^lint", group = ":soap: Linting" }, + { message = "^chore\\(release\\): prepare for", skip = true }, + { message = "^chore\\(deps\\)", skip = true }, + { message = "^chore\\(pr\\)", skip = true }, + { message = "^chore\\(pull\\)", skip = true }, + { message = "^relprep", skip = true }, + { message = "^chore|ci", group = ":gear: Miscellaneous Tasks" }, + { body = ".*security", group = ":closed_lock_with_key: Security" }, + { message = "^revert", group = ":x: Revert" }, + { message = "^automation", skip = true }, + ] + + # 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 = "beta|alpha" + + # regex for ignoring tags + ignore_tags = "rc" + + # sort the tags topologically + topo_order = true + + # sort the commits inside sections by oldest/newest order + sort_commits = "oldest" + # goplicate-end:git