Add manual trigger to ValidateBranchName workflow

- Included `workflow_dispatch` event in GitHub Actions - Allows for manual execution of the ValidateBranchName workflow
Add branch name validation configuration
2024-08-23 21:29:14 +02:00 · 2024-08-23 21:28:22 +02:00
6 changed files with 67 additions and 53 deletions
--- a/.github/config.conf
+++ b/.github/config.conf
@@ -0,0 +1,2 @@
+[branch_validation]
+valid_prefixes = feature/,fix/,refactoring/,testing/,dependabot/,gh-pages
--- a/.github/workflows/CreateRelease.yml
+++ b/.github/workflows/CreateRelease.yml
@@ -4,7 +4,6 @@ on:
    push:
        branches:
            - main
-            - 'dev/*'
        paths:
            - 'package.json'
    workflow_dispatch: # Allows manual execution of the workflow.
@@ -23,8 +22,14 @@ jobs:
              with:
                  node-version: '20.8.0'

-            - name: Install dependencies, run tests and build
-              run: npm run prepare:deploy
+            - name: Install Dependencies
+              run: npm install
+
+            - name: Run Tests
+              run: npm run test:verbose
+
+            - name: Build the Project
+              run: npm run build:tsc

            - name: Get the version
              id: get_version
@@ -72,9 +77,8 @@ jobs:
                  echo "Generating release notes from ${{ env.PREVIOUS_TAG }} to HEAD..."
                  repo_url=$(git config --get remote.origin.url)
                  notes=$(git log ${{ env.PREVIOUS_TAG }}..HEAD --pretty=format:"- [\`%h\`]($repo_url/commit/%H): %s%n")
-                  echo "See [CHANGELOG.md](./CHANGELOG.md) for more details."
+                  echo "Release notes:"
                  echo "$notes"
-                  echo ""
                  echo "### Changes in this release" > release_notes.md
                  echo "$notes" >> release_notes.md
              shell: bash
@@ -86,6 +90,17 @@ jobs:
                  git config --local user.email "actions@github.com"
              shell: bash

+            # - name: Create temporary branch
+            #   id: create_temp_branch
+            #   if: steps.check_version.outputs.skip_release == 'false'
+            #   run: |
+            #       git checkout --orphan release/v${{ env.VERSION }}
+            #       git reset
+            #       rm -f .gitignore
+            #       git add README.md package.json LICENSE dist/ src/ tsconfig.json
+            #       git commit -m "Prepare files for release ${{ env.VERSION }}"
+            #   shell: bash
+
            - name: Create and push tag
              id: create_tag
              if: steps.check_version.outputs.skip_release == 'false'
@@ -96,15 +111,6 @@ jobs:
                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
              shell: bash

-            - name: Set Release Prerelease Flag
-              id: set_prerelease_flag
-              run: |
-                  if [[ "${{ github.ref }}" == "refs/heads/main" ]]; then
-                    echo "PRE_RELEASE=false" >> $GITHUB_ENV
-                  elif [[ "${{ github.ref }}" == refs/heads/dev/* ]]; then
-                    echo "PRE_RELEASE=true" >> $GITHUB_ENV
-                  fi
-
            - name: Release
              if: steps.check_version.outputs.skip_release == 'false'
              uses: softprops/action-gh-release@v2
@@ -112,6 +118,6 @@ jobs:
                  tag_name: ${{ env.VERSION }}
                  name: Release ${{ env.VERSION }}
                  body_path: release_notes.md
-                  prerelease: ${{ env.PRE_RELEASE }}
+                  prerelease: true
              env:
                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/.github/workflows/ValidateBranchName.yml
+++ b/.github/workflows/ValidateBranchName.yml
@@ -3,7 +3,8 @@ name: Validate Branch Name on Pull Request
 on:
    pull_request:
        branches:
-            - UNDEFINED
+            - main
+    workflow_dispatch: # Allows manual execution of the workflow.

 jobs:
    validate-branch-name-on-pull-request:
@@ -13,11 +14,27 @@ jobs:
            - name: Check out repository
              uses: actions/checkout@v2

+            - name: Read Config File
+              id: config
+              run: |
+                  VALID_PREFIXES=$(grep 'valid_prefixes' .github/config.conf | cut -d '=' -f2 | tr -d ' ')
+                  echo "VALID_PREFIXES=$VALID_PREFIXES" >> $GITHUB_ENV
+
            - name: Validate Branch Name on Pull Request
              run: |
-                  BRANCH_NAME=${GITHUB_HEAD_REF}
-                  if [[ ! "$BRANCH_NAME" =~ ^(feature\/|fix\/|refactoring\/|testing\/|dependabot\/|gh-pages) ]]; then
+                  BRANCH_NAME=${{ github.head_ref }}
+                  VALID_PREFIXES_ARRAY=(${VALID_PREFIXES//,/ })
+                  VALID=false
+
+                  for PREFIX in "${VALID_PREFIXES_ARRAY[@]}"; do
+                    if [[ "$BRANCH_NAME" =~ ^$PREFIX ]]; then
+                      VALID=true
+                      break
+                    fi
+                  done
+
+                  if [ "$VALID" = false ]; then
                    echo "Invalid branch name: $BRANCH_NAME"
-                    echo "Branch name must start with 'feature/', 'fix/', 'refactoring/', 'testing/', dependabot/" or "gh-pages"
+                    echo "Branch name must start with one of the following prefixes: $VALID_PREFIXES"
                    exit 1
                  fi
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,8 +9,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

 ### Added

- Add pre release building to release workflow on dev/* branches an version changes.
-

 ### Deprecated

--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
  "name": "ts-injex",
-  "version": "0.1.0",
+  "version": "0.0.9",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "ts-injex",
-      "version": "0.1.0",
+      "version": "0.0.9",
      "license": "MIT",
      "dependencies": {
        "eslint-plugin-prettier": "^5.2.1",
@@ -20,7 +20,7 @@
        "@typescript-eslint/parser": "^8.1.0",
        "axios": "^1.7.2",
        "eslint-plugin-deprecation": "^3.0.0",
-        "eslint-plugin-import": "^2.31.0",
+        "eslint-plugin-import": "^2.29.1",
        "eslint-plugin-jsdoc": "^50.2.2",
        "eslint-plugin-override": "https://github.com/PxaMMaxP/eslint-plugin-override",
        "istanbul-badges-readme": "^1.9.0",
@@ -1187,12 +1187,6 @@
        "url": "https://opencollective.com/unts"
      }
    },
-    "node_modules/@rtsao/scc": {
-      "version": "1.1.0",
-      "resolved": "https://registry.npmjs.org/@rtsao/scc/-/scc-1.1.0.tgz",
-      "integrity": "sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==",
-      "dev": true
-    },
    "node_modules/@shikijs/core": {
      "version": "1.13.0",
      "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-1.13.0.tgz",
@@ -3001,9 +2995,9 @@
      }
    },
    "node_modules/eslint-module-utils": {
-      "version": "2.12.0",
-      "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz",
-      "integrity": "sha512-wALZ0HFoytlyh/1+4wuZ9FJCD/leWHQzzrxJ8+rebyReSLk7LApMyd3WJaLVoN+D5+WIdJyDK1c6JnE65V4Zyg==",
+      "version": "2.8.1",
+      "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.8.1.tgz",
+      "integrity": "sha512-rXDXR3h7cs7dy9RNpUlQf80nX31XWJEyGq1tRMo+6GsO5VmTe4UTwtmonAD4ZkAsrfMVDA2wlGJ3790Ys+D49Q==",
      "dev": true,
      "dependencies": {
        "debug": "^3.2.7"
@@ -3163,36 +3157,34 @@
      }
    },
    "node_modules/eslint-plugin-import": {
-      "version": "2.31.0",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.31.0.tgz",
-      "integrity": "sha512-ixmkI62Rbc2/w8Vfxyh1jQRTdRTF52VxwRVHl/ykPAmqG+Nb7/kNn+byLP0LxPgI7zWA16Jt82SybJInmMia3A==",
+      "version": "2.29.1",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz",
+      "integrity": "sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==",
      "dev": true,
      "dependencies": {
-        "@rtsao/scc": "^1.1.0",
-        "array-includes": "^3.1.8",
-        "array.prototype.findlastindex": "^1.2.5",
+        "array-includes": "^3.1.7",
+        "array.prototype.findlastindex": "^1.2.3",
        "array.prototype.flat": "^1.3.2",
        "array.prototype.flatmap": "^1.3.2",
        "debug": "^3.2.7",
        "doctrine": "^2.1.0",
        "eslint-import-resolver-node": "^0.3.9",
-        "eslint-module-utils": "^2.12.0",
-        "hasown": "^2.0.2",
-        "is-core-module": "^2.15.1",
+        "eslint-module-utils": "^2.8.0",
+        "hasown": "^2.0.0",
+        "is-core-module": "^2.13.1",
        "is-glob": "^4.0.3",
        "minimatch": "^3.1.2",
-        "object.fromentries": "^2.0.8",
-        "object.groupby": "^1.0.3",
-        "object.values": "^1.2.0",
+        "object.fromentries": "^2.0.7",
+        "object.groupby": "^1.0.1",
+        "object.values": "^1.1.7",
        "semver": "^6.3.1",
-        "string.prototype.trimend": "^1.0.8",
        "tsconfig-paths": "^3.15.0"
      },
      "engines": {
        "node": ">=4"
      },
      "peerDependencies": {
-        "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8 || ^9"
+        "eslint": "^2 || ^3 || ^4 || ^5 || ^6 || ^7.2.0 || ^8"
      }
    },
    "node_modules/eslint-plugin-import/node_modules/debug": {
@@ -4161,9 +4153,9 @@
      }
    },
    "node_modules/is-core-module": {
-      "version": "2.15.1",
-      "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz",
-      "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==",
+      "version": "2.15.0",
+      "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.0.tgz",
+      "integrity": "sha512-Dd+Lb2/zvk9SKy1TGCt1wFJFo/MWBPMX5x7KcvLajWTGuomczdQX61PvY5yK6SVACwpoexWo81IfFyoKY2QnTA==",
      "dev": true,
      "dependencies": {
        "hasown": "^2.0.2"
--- a/package.json
+++ b/package.json
@@ -22,8 +22,7 @@
    "docs:fix:coverage": "node scripts/fix-coverage-paths.cjs",
    "docs:generate:badge": "node scripts/generate-badge.cjs",
    "docs:fix:escape": "node scripts/replace-doc-escaping.cjs",
-    "version:show": "node -e \"console.log(require('./package.json').version)\"",
-    "prepare:deploy": "npm install && npm run test:verbose && npm run build:tsc"
+    "version:show": "node -e \"console.log(require('./package.json').version)\""
  },
  "repository": {
    "type": "git",
@@ -40,7 +39,7 @@
    "@typescript-eslint/eslint-plugin": "^8.1.0",
    "@typescript-eslint/parser": "^8.1.0",
    "eslint-plugin-deprecation": "^3.0.0",
-    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-import": "^2.29.1",
    "eslint-plugin-jsdoc": "^50.2.2",
    "eslint-plugin-override": "https://github.com/PxaMMaxP/eslint-plugin-override",
    "jest": "^29.7.0",