Add Workflow to auto-update changelog.md

.github/issue-branch.yml

@@ -0,0 +1,47 @@
+### Configuration file for ./workflows/create-branch-issue.yml
+# Have branches be created when issue is assniged
+mode: auto
+# Use naming scheme of "issue-[id]"
+branchName: short
+# Auto-close an issue after the corresponding PR has been merged into `develop`
+autoCloseIssue: true
+branches:
+  # Prefix based on issue
+  - label: model
+    prefix: model/
+  - label: bug
+    prefix: bugfix/
+  # Skip based on label
+  - label: duplicate
+    skip: true
+  - label: help wanted
+    skip: true
+  - label: question
+    skip: true
+  - label: invalid
+    skip: true
+  - label: wontfix
+    skip: true
+  # Open PR to merge `develop` into `release` when issue has label "release"
+  - label: release
+    name: develop
+    prTarget: release
+    skipBranch: true
+  # Let PRs labelled "codebase" have branch "yaml" as prTarget and `develop` as source
+  - label: codebase
+    name: develop
+    prTarget: yaml
+# Open a Draft PR on issue creation
+openDraftPR: true
+# Skip CI workflows on empty commits on  PR creation (This "Feature" is a GH requirement)
+prSkipCI: true
+# Copy attributes from issue into PR
+copyIssueDescriptionToPR: true
+copyIssueLabelsToPR: true
+copyIssueAssigneeToPR: true
+copyIssueProjectsToPR: true
+copyIssueMilestoneToPR: true
+# Create "[Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)" message (See [here](https://github.com/marketplace/actions/create-issue-branch#conventional-pull-request-titles))
+conventionalPrTitles: true
+# Use semantic versioning with gitmoji
+conventionalStyle: semver

.github/workflows/changelog.yml

@@ -0,0 +1,45 @@
+name: changelog 
+
+on:
+  push:
+    branches:
+      - ci
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+
+      - name: Get previous tag
+        id: previousTag
+        run: |
+          name=$(git --no-pager tag --sort=creatordate --merged ${{ github.ref_name }} | tail -2 | head -1)
+          echo "previousTag: $name"
+          echo "previousTag=$name" >> $GITHUB_ENV
+
+      - name: Update CHANGELOG
+        id: changelog
+        uses: requarks/changelog-action@v1.9.0
+        with:
+          token: ${{ github.token }}
+          fromTag: ${{ github.ref_name }}
+          toTag: ${{ env.previousTag }}
+          writeToFile: true 
+          excludeTypes: build,other,style
+      - name: Commit changelog
+        uses: EndBug/add-and-commit@v9
+        with:
+          add: CHANGELOG.md
+          default_author: github_actions
+          fetch: true
+          pathspec_error_handling: exitAtEnd
+          push: true
+          message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]'
+

.github/workflows/create-issue-branch.yml

@@ -0,0 +1,20 @@
+on:
+  # The issue.opened event below is only needed for the "immediate" mode.
+  # The issue.assigned event below is only needed for the default ("auto") mode.
+  issues:
+    types: 
+      - assigned
+  # The pull_request events below are only needed for pull-request related features.
+  pull_request:
+    types: 
+      - opened 
+      - closed
+
+jobs:
+  create_issue_branch_job:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create Issue Branch
+        uses: robvanderleek/create-issue-branch@main
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1 @@
+git-conventional-commits.yaml

CHANGELOG.md

@@ -1,14 +1,65 @@
-## v9
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Add models:
-	* 9mm Pistol
-	* .22LR Pistol
-	* .380 ACP Pistol
-	* .45 ACP Pistol
-	* .45 LC Revolver
-	* 10 Gauge Shotgun
-	* 12 Gauge Shotgun
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-* Change Glock 21 to use model: .45 ACP Pistol
+## [ci] - 2023-11-28
+### :sparkles: New Features
+- [`05d3400`](https://github.com/coavins/zomboid-coavins-firearms/commit/05d3400e926d3997ed086140fb68392774a9f510) - **model**: Add Type for BodyGuard380 *(commit by [@macinsight](https://github.com/macinsight))*
+- [`2e1914c`](https://github.com/coavins/zomboid-coavins-firearms/commit/2e1914c0b7d4afc25e676c06671a4250cb0db82d) - **model**: Add type for S&W M52 .38cal *(commit by [@macinsight](https://github.com/macinsight))*
+- [`f8b7358`](https://github.com/coavins/zomboid-coavins-firearms/commit/f8b7358b5ad693e14ffac46b92b35d17c35d9bba) - **model**: Add type for 1911 family *(commit by [@macinsight](https://github.com/macinsight))*
+- [`d2349f8`](https://github.com/coavins/zomboid-coavins-firearms/commit/d2349f86d4431ac5c878c22d699a81a32c999efb) - **model**: Add types to AR Variants *(commit by [@macinsight](https://github.com/macinsight))*
+- [`f9f5ac0`](https://github.com/coavins/zomboid-coavins-firearms/commit/f9f5ac0373879bbb50c13258537c06237a12a1a7) - **ci**: Add Workflow to upate changelogs on PR to develop-branch *(commit by [@macinsight](https://github.com/macinsight))*
+- [`3b3d802`](https://github.com/coavins/zomboid-coavins-firearms/commit/3b3d802cfd0720a8c2d00544d3ea701d09042aa0) - **ci**: Add CIB Workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`6c021ac`](https://github.com/coavins/zomboid-coavins-firearms/commit/6c021ac58535edf961515c300d28c02781dd9990) - **docs**: Update permitted committypes *(commit by [@macinsight](https://github.com/macinsight))*
 
-Contributors: macinsight
+### :bug: Bug Fixes
+- [`8ea2c7e`](https://github.com/coavins/zomboid-coavins-firearms/commit/8ea2c7e2b59a4ded16072a129b8af0b641394dbe) - **model**: Update weapon type for Colt 1855 *(PR [#88](https://github.com/coavins/zomboid-coavins-firearms/pull/88) by [@macinsight](https://github.com/macinsight))*
+  - :arrow_lower_right: *fixes issue [#62](undefined) opened by [@macinsight](https://github.com/macinsight)*
+- [`196d0f5`](https://github.com/coavins/zomboid-coavins-firearms/commit/196d0f5c604bd3c88d9e53ad3bc6d4616d05506e) - **model**: Assign correct types to SCAR Series *(commit by [@macinsight](https://github.com/macinsight))*
+- [`65057e5`](https://github.com/coavins/zomboid-coavins-firearms/commit/65057e596b59ddb80d7717d7b1b628789855a1a7) - **ci**: Change WF rules, add correct repo *(commit by [@macinsight](https://github.com/macinsight))*
+- [`06d9c91`](https://github.com/coavins/zomboid-coavins-firearms/commit/06d9c913cd9e59b1ae739ebe53222077439bdec2) - **ci**: Update Workflow rules *(commit by [@macinsight](https://github.com/macinsight))*
+- [`5357f65`](https://github.com/coavins/zomboid-coavins-firearms/commit/5357f65ef889cad6db02f4dcb3791f06e7df1b04) - **ci**: Fix file extension for CL workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`d304f04`](https://github.com/coavins/zomboid-coavins-firearms/commit/d304f047db98370c1c2daa153d118b813a6a6bc2) - **ci**: Fix L workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`a6050ed`](https://github.com/coavins/zomboid-coavins-firearms/commit/a6050ed4199c965b493126b4d5edeeb77270bacf) - **ci**: FIx linting in glc WF *(commit by [@macinsight](https://github.com/macinsight))*
+- [`5895aa7`](https://github.com/coavins/zomboid-coavins-firearms/commit/5895aa7a793932491075c6cea2378291e5c7e15a) - **ci**: Fix indent *(commit by [@macinsight](https://github.com/macinsight))*
+- [`5872e8e`](https://github.com/coavins/zomboid-coavins-firearms/commit/5872e8ea634a0adef7cb2a7ce0f4daf6e32577cd) - **ci**: Update changelog.yml to new action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`c747716`](https://github.com/coavins/zomboid-coavins-firearms/commit/c7477169ca87a225bed74899e61b17c9e13f72dc) - **ci**: Change version for changelog action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`50bade3`](https://github.com/coavins/zomboid-coavins-firearms/commit/50bade37b08bd1b519f9bb386a4c2521d1ccbbe5) - **ci**: Update changelog.yml with new action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`b3ba37f`](https://github.com/coavins/zomboid-coavins-firearms/commit/b3ba37f99c72ac7a0b7e5d7205592e6405207be4) - **ci**: Have changelog action write changes to changelog.md *(commit by [@macinsight](https://github.com/macinsight))*
+- [`b0c5f1d`](https://github.com/coavins/zomboid-coavins-firearms/commit/b0c5f1d10062a0ef0f2a315aa180c2baf2b3c59b) - **ci**: Remove redundant config option *(commit by [@macinsight](https://github.com/macinsight))*
+- [`6e0bc16`](https://github.com/coavins/zomboid-coavins-firearms/commit/6e0bc164ceb3a6591dc836862f0b37e2c6b28f08) - **ci**: Add name to cib workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`f40cf61`](https://github.com/coavins/zomboid-coavins-firearms/commit/f40cf6131d36c4ea448eb7e03dd0820fb586a44b) - **ci**: Update CIB Workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`2db89cf`](https://github.com/coavins/zomboid-coavins-firearms/commit/2db89cf2f315999c2fb892b54b65b68ffb27cd48) - **ci**: Add 'docs' to generated types *(commit by [@macinsight](https://github.com/macinsight))*
+- [`fe55681`](https://github.com/coavins/zomboid-coavins-firearms/commit/fe55681ea0190ba2746767bbb2accaef5ea0a5e8) - **ci**: Add correct arguments to update_changelog action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`0545bbe`](https://github.com/coavins/zomboid-coavins-firearms/commit/0545bbef90a2cbe4326e57b385ad5c8fdee074a1) - **ci**: Add permissions to git-auto-commit *(commit by [@macinsight](https://github.com/macinsight))*
+- [`1992e70`](https://github.com/coavins/zomboid-coavins-firearms/commit/1992e70da5a7cd0cf85160b1748acc8b3b75099d) - **ci**: Remove erroring permissons *(commit by [@macinsight](https://github.com/macinsight))*
+- [`561a187`](https://github.com/coavins/zomboid-coavins-firearms/commit/561a187d5c04694a9e2d43f65be56c8d1160121b) - **ci**: Update secret to use GITHUB_TOKEN *(commit by [@macinsight](https://github.com/macinsight))*
+- [`1034a63`](https://github.com/coavins/zomboid-coavins-firearms/commit/1034a639e83a3c881eb491d0b5b78275626c1b0e) - **ci**: Update git-auto-commit to v5 *(commit by [@macinsight](https://github.com/macinsight))*
+- [`74df28f`](https://github.com/coavins/zomboid-coavins-firearms/commit/74df28f9887bfb211d027858b3e87e5cc33ad425) - **ci**: Fix excludeTypes *(commit by [@macinsight](https://github.com/macinsight))*
+- [`4a0fbad`](https://github.com/coavins/zomboid-coavins-firearms/commit/4a0fbadb7b7fbfd0030e1a5d0332c1d087ba66f9) - **ci**: Change source tag for Changelog CI *(commit by [@macinsight](https://github.com/macinsight))*
+- [`0e623f3`](https://github.com/coavins/zomboid-coavins-firearms/commit/0e623f3c16eebbd58004a7d87534f9425cd19285) - **ci**: Update config for changelog-action, add permissions to token *(commit by [@macinsight](https://github.com/macinsight))*
+- [`05e0382`](https://github.com/coavins/zomboid-coavins-firearms/commit/05e03828cad88443747af910c076a6c296213d7b) - **ci**: Adjust roof commit range for CHANGELOG CI *(commit by [@macinsight](https://github.com/macinsight))*
+- [`f4ac1ad`](https://github.com/coavins/zomboid-coavins-firearms/commit/f4ac1ad384ff6233a7fdee1b87b33070734892a3) - **ci**: Adjust toTag of changelog action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`6f90706`](https://github.com/coavins/zomboid-coavins-firearms/commit/6f90706c830adc835dfcf0b698ea2df763bb15e5) - **ci**: Swap toTag and fromTag to have CI detect new commits *(commit by [@macinsight](https://github.com/macinsight))*
+- [`be2ea8a`](https://github.com/coavins/zomboid-coavins-firearms/commit/be2ea8a58cc1ab0beda27defb04adeb21bca16eb) - **ci**: Fix missing '$' in Workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`6af14cc`](https://github.com/coavins/zomboid-coavins-firearms/commit/6af14ccaa20a5b21a3bce092f7a47339af5cabce) - **ci**: Change writeToFile *(commit by [@macinsight](https://github.com/macinsight))*
+- [`27e728a`](https://github.com/coavins/zomboid-coavins-firearms/commit/27e728ae9f486defba88391b2fde0bf0c09c74aa) - **ci**: Change writeToFile to 'true' *(commit by [@macinsight](https://github.com/macinsight))*
+- [`1718910`](https://github.com/coavins/zomboid-coavins-firearms/commit/17189109bb6a5e6d76f02fe7e9a383f5033eb0e6) - **ci**: CHange order back to default *(commit by [@macinsight](https://github.com/macinsight))*
+
+### :white_check_mark: Tests
+- [`3280352`](https://github.com/coavins/zomboid-coavins-firearms/commit/3280352fb43dca9b4433af20ad1bca5014a786db) - **ci**: Update changelog.yml with new action *(commit by [@macinsight](https://github.com/macinsight))*
+
+### :memo: Documentation Changes
+- [`cc202e7`](https://github.com/coavins/zomboid-coavins-firearms/commit/cc202e7ef667b92f36f0fa3fb0959004d56cfe45) - update CHANGELOG.md for ci [skip ci] *(commit by [@macinsight](https://github.com/macinsight))*
+- [`eeab719`](https://github.com/coavins/zomboid-coavins-firearms/commit/eeab71975346c346c32b6fb0c7bb77f74aa5311d) - **contrib**: Update to CC standard *(commit by [@macinsight](https://github.com/macinsight))*
+- [`1f54eba`](https://github.com/coavins/zomboid-coavins-firearms/commit/1f54ebac07c6e6bbb6da9529ef5839d243deb4a2) - **ci**: Change generated CHANGELOG.md from 'oldest first' to 'newest first' *(commit by [@macinsight](https://github.com/macinsight))*
+- [`c5479c9`](https://github.com/coavins/zomboid-coavins-firearms/commit/c5479c93fb6263deb535f9a90c06c65eea82a040) - **ci**: Change Changelog.md to see if it regenerates *(commit by [@macinsight](https://github.com/macinsight))*
+
+### :wrench: Chores
+- [`af385f8`](https://github.com/coavins/zomboid-coavins-firearms/commit/af385f829673477d1ced84ac3f983954f57a69b3) - **ci**: Update requarks/changelog-action to latest *(commit by [@macinsight](https://github.com/macinsight))*
+- [`9f69529`](https://github.com/coavins/zomboid-coavins-firearms/commit/9f69529fad4dc44a91309e04c4454a8d27d275b1) - **ci**: Set latest tag for changelog CI *(commit by [@macinsight](https://github.com/macinsight))*
+
+
+[ci]: https://github.com/coavins/zomboid-coavins-firearms/compare/v7...ci

CHANGELOG_old.md

@@ -0,0 +1,43 @@
+## [ci] - 2023-11-28
+### :sparkles: New Features
+- [`05d3400`](https://github.com/coavins/zomboid-coavins-firearms/commit/05d3400e926d3997ed086140fb68392774a9f510) - **model**: Add Type for BodyGuard380 *(commit by [@macinsight](https://github.com/macinsight))*
+- [`2e1914c`](https://github.com/coavins/zomboid-coavins-firearms/commit/2e1914c0b7d4afc25e676c06671a4250cb0db82d) - **model**: Add type for S&W M52 .38cal *(commit by [@macinsight](https://github.com/macinsight))*
+- [`f8b7358`](https://github.com/coavins/zomboid-coavins-firearms/commit/f8b7358b5ad693e14ffac46b92b35d17c35d9bba) - **model**: Add type for 1911 family *(commit by [@macinsight](https://github.com/macinsight))*
+- [`d2349f8`](https://github.com/coavins/zomboid-coavins-firearms/commit/d2349f86d4431ac5c878c22d699a81a32c999efb) - **model**: Add types to AR Variants *(commit by [@macinsight](https://github.com/macinsight))*
+- [`f9f5ac0`](https://github.com/coavins/zomboid-coavins-firearms/commit/f9f5ac0373879bbb50c13258537c06237a12a1a7) - **ci**: Add Workflow to upate changelogs on PR to develop-branch *(commit by [@macinsight](https://github.com/macinsight))*
+
+### :bug: Bug Fixes
+- [`8ea2c7e`](https://github.com/coavins/zomboid-coavins-firearms/commit/8ea2c7e2b59a4ded16072a129b8af0b641394dbe) - **model**: Update weapon type for Colt 1855 *(PR [#88](https://github.com/coavins/zomboid-coavins-firearms/pull/88) by [@macinsight](https://github.com/macinsight))*
+  - :arrow_lower_right: *fixes issue [#62](undefined) opened by [@macinsight](https://github.com/macinsight)*
+- [`196d0f5`](https://github.com/coavins/zomboid-coavins-firearms/commit/196d0f5c604bd3c88d9e53ad3bc6d4616d05506e) - **model**: Assign correct types to SCAR Series *(commit by [@macinsight](https://github.com/macinsight))*
+- [`65057e5`](https://github.com/coavins/zomboid-coavins-firearms/commit/65057e596b59ddb80d7717d7b1b628789855a1a7) - **ci**: Change WF rules, add correct repo *(commit by [@macinsight](https://github.com/macinsight))*
+- [`06d9c91`](https://github.com/coavins/zomboid-coavins-firearms/commit/06d9c913cd9e59b1ae739ebe53222077439bdec2) - **ci**: Update Workflow rules *(commit by [@macinsight](https://github.com/macinsight))*
+- [`5357f65`](https://github.com/coavins/zomboid-coavins-firearms/commit/5357f65ef889cad6db02f4dcb3791f06e7df1b04) - **ci**: Fix file extension for CL workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`d304f04`](https://github.com/coavins/zomboid-coavins-firearms/commit/d304f047db98370c1c2daa153d118b813a6a6bc2) - **ci**: Fix L workflow *(commit by [@macinsight](https://github.com/macinsight))*
+- [`a6050ed`](https://github.com/coavins/zomboid-coavins-firearms/commit/a6050ed4199c965b493126b4d5edeeb77270bacf) - **ci**: FIx linting in glc WF *(commit by [@macinsight](https://github.com/macinsight))*
+- [`5895aa7`](https://github.com/coavins/zomboid-coavins-firearms/commit/5895aa7a793932491075c6cea2378291e5c7e15a) - **ci**: Fix indent *(commit by [@macinsight](https://github.com/macinsight))*
+- [`5872e8e`](https://github.com/coavins/zomboid-coavins-firearms/commit/5872e8ea634a0adef7cb2a7ce0f4daf6e32577cd) - **ci**: Update changelog.yml to new action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`c747716`](https://github.com/coavins/zomboid-coavins-firearms/commit/c7477169ca87a225bed74899e61b17c9e13f72dc) - **ci**: Change version for changelog action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`50bade3`](https://github.com/coavins/zomboid-coavins-firearms/commit/50bade37b08bd1b519f9bb386a4c2521d1ccbbe5) - **ci**: Update changelog.yml with new action *(commit by [@macinsight](https://github.com/macinsight))*
+- [`b3ba37f`](https://github.com/coavins/zomboid-coavins-firearms/commit/b3ba37f99c72ac7a0b7e5d7205592e6405207be4) - **ci**: Have changelog action write changes to changelog.md *(commit by [@macinsight](https://github.com/macinsight))*
+
+### :white_check_mark: Tests
+- [`3280352`](https://github.com/coavins/zomboid-coavins-firearms/commit/3280352fb43dca9b4433af20ad1bca5014a786db) - **ci**: Update changelog.yml with new action *(commit by [@macinsight](https://github.com/macinsight))*
+
+
+## v9
+
+* Add models:
+	* 9mm Pistol
+	* .22LR Pistol
+	* .380 ACP Pistol
+	* .45 ACP Pistol
+	* .45 LC Revolver
+	* 10 Gauge Shotgun
+	* 12 Gauge Shotgun
+
+* Change Glock 21 to use model: .45 ACP Pistol
+
+Contributors: macinsight
+
+[ci]: https://github.com/coavins/zomboid-coavins-firearms/compare/v7...ci

CONTRIBUTING.md

@@ -13,14 +13,15 @@ Please create a pull request targeting the `develop` branch with a clear explana
 
 You should create a new branch for each pull request, and rebase/squash it into as few logical commits as possible.
 
-This repository generally follows the [Chris Beams standards](https://cbea.ms/git-commit/) for commit messages:
-
-    Separate subject from body with a blank line
-    Limit the subject line to 50 characters
-    Capitalize the subject line
-    Use the imperative mood in the subject line
-    Do not end the subject line with a period
-    Use the body to explain what and why vs. how
-    Wrap the body at 72 characters
+## Commit guidelines
+
+This repository generally adheres to the "[Conventional Commit](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13)" standards for commit messages to automate various steps i the build process:
+
+- Format: `<type>(<scope>): <description>`
+- Examples:
+  - **New Model:** `feat(model): implement password recovery`
+  - **Bug Fix:** `fix(validation): address input validation edge case`
+  - **Chore:** `chore(docs): update contribution guidelines`
+
 
 Your commits will be expected to meet these standards before your PR will be merged.