Merge branch 'release/1.0.1'

nekofar · Nov 2, 2023 · e13ed09 · e13ed09
2 parents 990655f + a77ef3b
commit e13ed09
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 67 deletions.
diff --git a/.github/workflows/prepare.yml b/.github/workflows/prepare.yml
@@ -26,7 +26,7 @@ jobs:
     steps:
       # Checks-out the repository
       - name: Checkout code
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       # Runs ShellCheck on all shell scripts in your repository
       - name: Run ShellCheck
@@ -41,13 +41,13 @@ jobs:
     steps:
       # Checkout the repository code
       - name: Checkout code
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0 # Fetches all history for all branches and tags
 
       # Generate a changelog for the new release using Git
       - name: Generate a changelog
-        uses: orhun/git-cliff-action@v2.0.6
+        uses: orhun/git-cliff-action@v2.1.1
         id: git-cliff
         with:
           config: cliff.toml # The configuration file for git-cliff

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -18,7 +18,7 @@ jobs:
 
       # First, we check out the repository code
       - name: Checkout code
-        uses: actions/checkout@v3.5.3
+        uses: actions/checkout@v4.1.1
 
       # In the next step, we configure the git user to allow pushing to the repository
       - name: Configure Git

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,200 +2,191 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.0.0-beta.12] - 2023-08-21
+## [1.0.1] - 2023-11-02
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
-- Adjust condition check in `entrypoint.sh` to handle float
+- Solve some minor issues and update dependencies
 
-### <!-- 07 -->Continuous Integrations
+## [1.0.0-beta.12] - 2023-08-21
 
-- Bump nekofar/create-github-release from 1.0.11 to 1.0.12 
+### Bug Fixes
+
+- Adjust condition check in `entrypoint.sh` to handle float
 
 ## [1.0.0-beta.11] - 2023-07-31
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Replace expr with awk in `entrypoint.sh` for calculations
 
 ## [1.0.0-beta.10] - 2023-07-28
 
-### <!-- 05 -->Documentation
+### Documentation
 
 - Rework job order and dependencies in GitHub workflow
 
 ## [1.0.0-beta.9] - 2023-07-28
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Update GitHub token authentication process in `entrypoint.sh`
 
 ## [1.0.0-beta.8] - 2023-07-28
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Trim whitespaces from input token in `entrypoint.sh`
 
 ## [1.0.0-beta.7] - 2023-07-27
 
-### <!-- 05 -->Documentation
+### Documentation
 
 - Add Personal Access Token information to README.md
 
 ## [1.0.0-beta.6] - 2023-07-27
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Adjust indentation level in `action.yml`
 - Optimize public repo message in `entrypoint.sh`
 
-### <!-- 07 -->Continuous Integrations
-
-- Bump nekofar/create-github-release from 1.0.8 to 1.0.11 
-
 ## [1.0.0-beta.5] - 2023-07-27
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Optimize if conditions of usage calculation in `entrypoint.sh`
 
 ## [1.0.0-beta.4] - 2023-07-27
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Add option to activate debug mode in `entrypoint.sh`
 
-### <!-- 07 -->Continuous Integrations
-
-- Bump nekofar/create-github-release from 1.0.6 to 1.0.8 
-
 ## [1.0.0-beta.3] - 2023-07-26
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Change default value of `GITHUB_TOKEN` in `entrypoint.sh`
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Optimize whitespace usage in `action.yml`
 
 ## [1.0.0-beta.2] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Update icon and color in `action.yml`
 
 ## [1.0.0-beta.1] - 2023-07-25
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Add comments and increase readability in monitor script
 
 ## [1.0.0-alpha.9] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Correct notification message formatting in `entrypoint.sh`
 
-### <!-- 07 -->Continuous Integrations
+### Miscellaneous Tasks
 
 - Add dependency to the `lint` job in `prepare.yml`
 - Increase usage guard threshold in GitHub workflow
 
 ## [1.0.0-alpha.8] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Remove unnecessary newline in echo statements in `entrypoint.sh`
 
-### <!-- 04 -->Refactor
+### Refactor
 
-- Remove 'x' option from bash shell settings in entry script
+- Remove `x` option from bash shell settings in entry script
 
 ## [1.0.0-alpha.7] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Specify repository in GitHub run cancellation command
 
 ## [1.0.0-alpha.6] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Add repository argument to gh repo view in `entrypoint.sh`
 
 ## [1.0.0-alpha.5] - 2023-07-25
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Add verbosity to error handling in `entrypoint.sh`
 
-### <!-- 07 -->Continuous Integrations
+### Miscellaneous Tasks
 
 - Remove checkout step from `prepare.yml`
 
 ## [1.0.0-alpha.4] - 2023-07-25
 
-### <!-- 07 -->Continuous Integrations
+### Miscellaneous Tasks
 
 - Refactor tag version in `prepare.yml`
 - Update job name from `lint` to `guard` in `prepare.yml`
 - Updated threshold for usage guard in Github workflow
 
 ## [1.0.0-alpha.3] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Remove redundant echo of Github token in `entrypoint.sh`
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Update usage messages in `entrypoint.sh`
 - Update shell script for improved readability and user-friendliness
 
 ## [1.0.0-alpha.2] - 2023-07-25
 
-### <!-- 04 -->Refactor
+### Refactor
 
 - Add verbosity to entrypoint.sh script execution
 
 ## [1.0.0-alpha.1] - 2023-07-25
 
-### <!-- 02 -->Bug Fixes
+### Bug Fixes
 
 - Update description and requirement status of GitHub token in `action.yml`
 
-### <!-- 05 -->Documentation
+### Documentation
 
 - Update GitHub token in Action config for better access control
 
-### <!-- 07 -->Continuous Integrations
+### Miscellaneous Tasks
 
 - Update GitHub token in Action Usage Guard
 
 ## [1.0.0-alpha.0] - 2023-07-25
 
-### <!-- 01 -->Features
+### Features
 
 - Create usage guard action and token authentication utility
 
-### <!-- 05 -->Documentation
+### Documentation
 
 - Add Apache License 2.0 to the project
 - Add issue templates for bug reports and feature requests
 - Add support for funding in project
 - Add `CONTRIBUTING.md` for project contributions guidance
 - Add `README` for Action Usage Guard
 
-### <!-- 07 -->Continuous Integrations
+### Miscellaneous Tasks
 
 - Add GitHub actions for release preparation and publishing
 - Add dependabot configuration for GitHub Actions
 - Add `stalebot` configuration file
-- Add Action Usage Guard to workflow and update checkout version
-
-### <!-- 08 -->Miscellaneous Tasks
-
 - Add `git-cliff` configuration file
+- Add Action Usage Guard to workflow and update checkout version
 
 <!-- generated by git-cliff -->
diff --git a/cliff.toml b/cliff.toml
@@ -32,7 +32,13 @@ trim = true
 footer = """
 <!-- generated by git-cliff -->
 """
-
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+  { pattern = '<!--\s\d+\s-->', replace = '' },
+  { pattern = "'", replace = '`' },
+  { pattern = '"', replace = '`' },
+]
 [git]
 # parse the commits based on https://www.conventionalcommits.org
 conventional_commits = true
@@ -42,23 +48,26 @@ filter_unconventional = true
 split_commits = false
 # regex for preprocessing the commit messages
 commit_preprocessors = [
-    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = ""},
+  # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
 ]
 # regex for parsing and grouping commits
 commit_parsers = [
-    { message = "^feat", group = "<!-- 01 -->Features"},
-    { message = "^fix", group = "<!-- 02 -->Bug Fixes"},
-    { message = "^docs\\(changelog\\)", skip = true},
-    { message = "^doc", group = "<!-- 05 -->Documentation"},
-    { message = "^perf", group = "Performance", skip = true},
-    { message = "^refactor", group = "<!-- 04 -->Refactor"},
-    { message = "^style", group = "Styling", skip = true},
-    { message = "^test", group = "<!-- 03 -->Testing"},
+  { message = "^feat", group = "<!-- 01 -->Features" },
+  { message = "^fix", group = "<!-- 02 -->Bug Fixes" },
+  { message = "^docs\\(changelog\\)", skip = true },
+  { message = "^doc", group = "<!-- 05 -->Documentation" },
+  { message = "^perf", group = "Performance" },
+  { message = "^refactor", group = "<!-- 04 -->Refactor" },
+  { message = "^style", group = "Styling" },
+  { message = "^test", group = "<!-- 03 -->Testing" },
   { message = "^chore\\(release\\): prepare for", skip = true },
-    { message = "^chore", group = "<!-- 08 -->Miscellaneous Tasks"},
-    { message = "^build", group = "<!-- 06 -->Build Environment"},
-    { message = "^ci", group = "<!-- 07 -->Continuous Integrations"},
-    { body = ".*security", group = "<!-- 00 -->Security"},
+  { message = "^chore\\(deps(?:-dev)?\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^ci\\(deps\\)", skip = true },
+  { message = "^build|chore|ci", group = "<!-- 08 -->Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 00 -->Security" },
+  { message = "^revert", group = "<!-- 09 -->Revert" },
 ]
 # protect breaking changes from being skipped due to matching a skipping commit_parser
 protect_breaking_commits = false
@@ -69,7 +78,7 @@ tag_pattern = "v[0-9]*"
 # regex for skipping tags
 skip_tags = "v0.1.0-beta.1"
 # regex for ignoring tags
-ignore_tags = "^v[0-9]$"
+ignore_tags = ""
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order