docs: Generate the initial CHANGELOG.

northwood-labs · Mar 27, 2024 · 7c72b2e · 7c72b2e
1 parent 737f0ec
commit 7c72b2e
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 78 deletions.
diff --git 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
@@ -0,0 +1,48 @@
+# 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))
+* [`a7a0295`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/a7a0295a3cf06759aafc4f756ab963fde0535af9): Enable generation of CHANGELOG. ([@skyzyx](https://github.com/skyzyx))
+* [`7cea255`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/7cea2559d089c74602b72d378abb85b0a40bbff2): Generate the initial CHANGELOG. ([@skyzyx](https://github.com/skyzyx))
+* [`4d61dde`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/4d61dde5f5d14d2169a1711d4c2fcca64bbd5368): Generate the initial CHANGELOG. ([@skyzyx](https://github.com/skyzyx))
+
+### :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-networking/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))
+
+### <!-- 0 -->:rocket: Features
+
+* [`5503847`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/55038470a1bd87a2c9f6568ca05ece18593bc349): Initial commit ([@skyzyx](https://github.com/skyzyx))
+
+### <!-- 1 -->:bug: Bug Fixes
+
+* [`996dc1d`](https://github.com/northwood-labs/terraform-provider-corefunc/commit/996dc1d4fe61bb6c53c5dd769961c913e551e5be): First working version. ([@skyzyx](https://github.com/skyzyx))
+
+### <!-- ZZZ -->: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-networking/issues/2)) ([@step-security-bot](https://github.com/step-security-bot))
+
+<p>Generated on 2024-03-26.</p>
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -0,0 +1,9 @@
+# File @generated by scripts/generate-contributors.sh. DO NOT EDIT.
+# This file lists all contributors to the repository.
+# See scripts/generate-contributors.sh to make modifications.
+
+dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+github-actions[bot] <github-actions[bot]@users.noreply.github.com>
+Northwood Labs (Bot) <[email protected]>
+Ryan Parman <[email protected]>
+StepSecurity Bot <[email protected]>
diff --git a/cliff.toml b/cliff.toml
@@ -7,22 +7,22 @@
 
 [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.
 
 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,89 +49,88 @@ 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 = """
 
 <p>Generated on {{ now() | date(format="%Y-%m-%d") }}.</p>
 """
-# goplicate-end:changelog
+  # goplicate-end:changelog
 
   postprocessors = [
-    { pattern = "linrinf", replace = "linting" },
-    { pattern = "storage.googleapis.com:433", replace = "`storage.googleapis.com:443`" },
     { pattern = "([^ ]+)\\(\\)", replace = "`$0`" },
     { pattern = "AUTHORS|CONTRIBUTORS|CONTRIBUTING|README", replace = "$0.md" },
     { pattern = "([^ ]+)\\.md", replace = "`$0`" },
     { pattern = "([^ ]+)\\.ya?ml", replace = "`$0`" },
     { pattern = "\\.md\\.md", replace = ".md" },
     { pattern = "go\\.(mod|sum)", replace = "`$0`" },
     { pattern = "(?i)pkg\\.go\\.dev", replace = "`$0`" },
-    { pattern = "corefunc_([^(\\.|\\s)]+)", replace = "`$0`" },
     { pattern = "Bump ([^ ]+)", replace = "Bump `$1`" },
     { pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](@REPO/issues/${1}))" },
-    { pattern = '@REPO', replace = "https://github.com/northwood-labs/mod-aws-resource-tags" },
+    { pattern = '@REPO', replace = "https://github.com/northwood-labs/mod-aws-networking" },
   ]
 
 # 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}](<REPO>/issues/${2}))"}, # replace issue numbers
-]
-
-# regex for parsing and grouping commits
-commit_parsers = [
-  { message = "^feat", group = "<!-- 0 -->:rocket: Features" },
-  { message = "^fix", group = "<!-- 1 -->:bug: Bug Fixes" },
-  { message = "^perf", group = "<!-- 2 -->: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 = "<!-- ZZZ -->:gear: Miscellaneous Tasks" },
-  { body = ".*security", group = ":closed_lock_with_key: Security" },
-  { message = "^revert", group = "<!-- ZYY -->: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}](<REPO>/issues/${2}))"}, # replace issue numbers
+  ]
+
+  # regex for parsing and grouping commits
+  commit_parsers = [
+    { message = "^feat", group = "<!-- 0 -->:rocket: Features" },
+    { message = "^fix", group = "<!-- 1 -->:bug: Bug Fixes" },
+    { message = "^perf", group = "<!-- 2 -->:racecar: Performance" },
+    { message = "^docs", group = ":books: Documentation" },
+    { message = "^refactor", group = ":tractor: Refactor" },
+    { message = "^style", group = ":art: Styling" },
+    { message = "^sync", group = "<!-- ZXX -->:arrows_counterclockwise: Configuration Syncing" },
+    { 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 = "<!-- ZZZ -->:gear: Miscellaneous Tasks" },
+    { message = "^security", group = ":closed_lock_with_key: Security" },
+    { body = ".*security", group = ":closed_lock_with_key: Security" },
+    { message = "^revert", group = "<!-- ZYY -->: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