feat: Add workflows

.github/workflows/codacy.yml

@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: Apache-2.0
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow checks out code, performs a Codacy security scan
+# and integrates the results with the
+# GitHub Advanced Security code scanning feature.  For more information on
+# the Codacy security scan action usage and parameters, see
+# https://github.com/codacy/codacy-analysis-cli-action.
+# For more information on Codacy Analysis CLI in general, see
+# https://github.com/codacy/codacy-analysis-cli.
+
+name: Codacy Security Scan
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '17 0 * * 4'
+
+permissions:
+  contents: read
+
+jobs:
+  codacy-security-scan:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: Codacy Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the repository to the GitHub Actions runner
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis
+      - name: Run Codacy Analysis CLI
+        uses: codacy/codacy-analysis-cli-action@d840f886c4bd4edc059706d09c6a1586111c540b
+        with:
+          # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository
+          # You can also omit the token and run the tools that support default configurations
+          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+          verbose: true
+          output: results.sarif
+          format: sarif
+          # Adjust severity of non-security issues
+          gh-code-scanning-compat: true
+          # Force 0 exit code to allow SARIF file generation
+          # This will handover control about PR rejection to the GitHub side
+          max-allowed-issues: 2147483647
+
+      # Upload the SARIF file generated in the previous step
+      - name: Upload SARIF results file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          sarif_file: results.sarif

.github/workflows/codeql.yml

@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: Apache-2.0
+
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '34 0 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -0,0 +1,22 @@
+# SPDX-License-Identifier: Apache-2.0
+
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v2

.github/workflows/milestone.yml

@@ -0,0 +1,52 @@
+# SPDX-License-Identifier: Apache-2.0
+
+name: Milestone Workflow
+
+on:
+  workflow_dispatch:
+    inputs:
+      milestoneId:
+        description: 'Milestone ID'
+        required: true
+        default: '1'
+
+jobs:
+  close_milestone:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js (.npmrc)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: https://npm.pkg.github.com/
+          # Defaults to the user or organization that owns the workflow file
+          scope: '@frmscoe'
+
+      - name: Install dependencies
+        run: npm ci
+        env:
+          GH_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+
+      - name: Close Milestone
+        run: |
+          ACCESS_TOKEN="${{ secrets.GITHUB_TOKEN }}"
+          MILESTONE_NUMBER=${{ github.event.inputs.milestoneId }}
+          API_URL="https://api.github.com"
+          
+          curl -X PATCH \
+            -H "Accept: application/vnd.github.v3+json" \
+            -H "Authorization: Bearer $ACCESS_TOKEN" \
+            -d '{"state": "closed"}' \
+            $API_URL/repos/${{ github.repository }}/milestones/$MILESTONE_NUMBER
+            
+      - name: Trigger Release Workflow
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: release
+          client-payload: '{"milestone_number": "${{ github.event.inputs.milestoneId }}"}'

.github/workflows/njsscan.yml

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: Apache-2.0
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# This workflow integrates njsscan with GitHub's Code Scanning feature
+# nodejsscan is a static security code scanner that finds insecure code patterns in your Node.js applications
+
+name: njsscan sarif
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '17 17 * * 1'
+
+permissions:
+  contents: read
+
+jobs:
+  njsscan:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    runs-on: ubuntu-latest
+    name: njsscan code scanning
+    steps:
+    - name: Checkout the code
+      uses: actions/checkout@v3
+    - name: nodejsscan scan
+      id: njsscan
+      uses: ajinabraham/njsscan-action@7237412fdd36af517e2745077cedbf9d6900d711
+      with:
+        args: '. --sarif --output results.sarif || true'
+    - name: Upload njsscan report
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: results.sarif

.github/workflows/node.js.yml

@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: Apache-2.0
+
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: install, build, test
+    permissions:
+      packages: write
+      contents: read
+    strategy:
+      matrix:
+        node-version: [20]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2 
+        with: 
+          version: 7
+      - name: Setup Node.js (.npmrc)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+          registry-url: https://npm.pkg.github.com/
+          # Defaults to the user or organization that owns the workflow file
+          scope: '@frmscoe'
+      - name: Install dependencies
+        run: npm ci
+        env:
+          GH_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+      - name: Run unit tests
+        run: npm run test
+        env:
+            NODE_ENV: 'test'
+            STARTUP_TYPE: 'nats'

.github/workflows/release.yml

@@ -0,0 +1,207 @@
+# SPDX-License-Identifier: Apache-2.0
+
+name: Release Workflow
+
+on:
+  repository_dispatch:
+    types: [release]
+    properties:
+      milestone_number:
+        type: string
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v2
+        with:
+          ref: main
+          fetch-depth: 0 # Fetch all tags
+
+      # Fetch merged pull request and determine release labels
+      - uses: actions-ecosystem/action-get-merged-pull-request@v1
+        id: get-merged-pull-request
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions-ecosystem/action-release-label@v1
+        id: release-label
+        if: ${{ steps.get-merged-pull-request.outputs.title != null }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          #labels: ${{ steps.get-merged-pull-request.outputs.labels }}
+
+      # Get the latest tag in the repositorys
+      - uses: actions-ecosystem/action-get-latest-tag@v1
+        id: get-latest-tag
+        if: ${{ steps.release-label.outputs.level != null }}
+        with:
+          semver_only: true
+
+      - name: Setup Node.js (.npmrc)
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: https://npm.pkg.github.com/
+          # Defaults to the user or organization that owns the workflow file
+          scope: '@frmscoe'
+
+      - name: Install dependencies
+        run: npm ci
+        env:
+          GH_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+
+      - name: Run Tests
+        run: npm test
+        env:
+          STARTUP_TYPE: 'nats'
+
+      # Determine the release type (major, minor, patch) based on commit messages  
+      - name: Determine Release Type
+        id: determine_release
+        run: |
+          export PREV_VERSION=$(git describe --abbrev=0 --tags)
+          echo "Previous Version: $PREV_VERSION"
+          
+          export COMMIT_MESSAGES=$(git log $PREV_VERSION^..HEAD --format=%B)
+          echo "Commit Messages: $COMMIT_MESSAGES"
+          
+          # Determine release type based on commit messages and labels
+          RELEASE_TYPE="patch"  # Default to patch
+          
+          if echo "$COMMIT_MESSAGES" | grep -q -e "BREAKING CHANGE:"; then
+            RELEASE_TYPE="major"
+          elif echo "$COMMIT_MESSAGES" | grep -q -e "feat:"; then
+            RELEASE_TYPE="minor"
+          elif echo "$COMMIT_MESSAGES" | grep -q -e "feat:" && (echo "$COMMIT_MESSAGES" | grep -q -e "fix:" || echo "$COMMIT_MESSAGES" | grep -q -e "enhancement:" || echo "$COMMIT_MESSAGES" | grep -q -e "docs:" || echo "$COMMIT_MESSAGES" | grep -q -e "refactor:" || echo "$COMMIT_MESSAGES" | grep -q -e "chore:"); then
+            RELEASE_TYPE="minor"
+          elif echo "$COMMIT_MESSAGES" | grep -q -e "fix:" -e "enhancement:" -e "docs:" -e "refactor:" -e "chore:"; then
+            RELEASE_TYPE="patch"
+          fi
+                    
+          echo "Release Type: $RELEASE_TYPE"
+          echo "::set-output name=release_type::$RELEASE_TYPE"
+        
+      # Bump the version based on the determined release type
+      - name: Bump Version
+        id: bump_version
+        run: |
+          export PREV_VERSION=$(git describe --abbrev=0 --tags)
+          echo "Previous Version: $PREV_VERSION"
+          
+          export RELEASE_TYPE=${{ steps.determine_release.outputs.release_type }}
+          echo "Release Type: $RELEASE_TYPE"
+          
+          export VERSION_PARTS=($(echo $PREV_VERSION | tr '.' '\n'))
+          MAJOR=${VERSION_PARTS[0]}
+          MINOR=${VERSION_PARTS[1]}
+          PATCH=${VERSION_PARTS[2]}
+          
+          if [[ $RELEASE_TYPE == "major" ]]; then
+            MAJOR=$((MAJOR + 1))
+            MINOR=0
+            PATCH=0
+          elif [[ $RELEASE_TYPE == "minor" ]]; then
+              MINOR=$((MINOR + 1))
+              PATCH=0
+          else
+            PATCH=$((PATCH + 1))
+          fi
+          
+          NEW_VERSION="$MAJOR.$MINOR.$PATCH"
+          echo "New Version: $NEW_VERSION"
+          echo "::set-output name=new_version::$NEW_VERSION"
+  
+      # Get the milestone details
+      - name: Get Milestone Details
+        id: get_milestone
+        run: |
+          # Retrieve the milestone ID from the workflow input
+          MILESTONE_ID=${{ github.event.client_payload.milestone_number }}
+          MILESTONE_RESPONSE=$(curl -s -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" "https://api.github.com/repos/${{ github.repository }}/milestones/${MILESTONE_ID}")
+          MILESTONE_TITLE=$(echo "$MILESTONE_RESPONSE" | jq -r '.title')
+          MILESTONE_DESCRIPTION=$(echo "$MILESTONE_RESPONSE" | jq -r '.description')
+          MILESTONE_DATE=$(echo "$MILESTONE_RESPONSE" | jq -r '.due_on')
+          echo "::set-output name=milestone_title::$MILESTONE_TITLE"
+          echo "::set-output name=milestone_description::$MILESTONE_DESCRIPTION"
+          echo "::set-output name=milestone_date::$MILESTONE_DATE"
+
+      # Generate the changelog based on commit messages and labels
+      - name: Generate Changelog
+        id: generate_changelog
+        run: |
+          # Generate Changelog Script
+          # Constants
+          CHANGELOG_FILE="/home/runner/work/changelog.txt"
+          LABEL_BUG="fix:"
+          LABEL_FEATURE="feat:"
+          LABEL_ENHANCEMENT="enhancement:"
+          LABEL_DOCS="docs:"
+          LABEL_REFACTOR="refactor:"
+          LABEL_CHORE="chore:"
+          LABEL_BREAKING_CHANGE="BREAKING CHANGE:"
+          # Get the last release tag
+          LAST_RELEASE_TAG=$(git describe --abbrev=0 --tags)
+          # Get the milestone details from the output of the previous step
+          MILESTONE_TITLE="${{ steps.get_milestone.outputs.milestone_title }}"
+          MILESTONE_DESCRIPTION="${{ steps.get_milestone.outputs.milestone_description }}"
+          MILESTONE_DATE="${{ steps.get_milestone.outputs.milestone_date }}"
+          # Append the milestone details to the changelog file
+          echo "## Milestone: $MILESTONE_TITLE" >> "$CHANGELOG_FILE"
+          echo "Date: $MILESTONE_DATE" >> "$CHANGELOG_FILE"
+          echo "Description: $MILESTONE_DESCRIPTION" >> "$CHANGELOG_FILE"
+          echo "" >> "$CHANGELOG_FILE"
+          # Function to append section to the changelog file
+          append_section() {
+            local section_title="$1"
+            local section_label="$2"
+            local section_icon="$3"
+            # Get the commit messages with the specified label between the last release and the current release
+            local commit_messages=$(git log --pretty=format:"- %s (Milestone: %b, Linked Issues: %C(yellow)%H%Creset)" "$LAST_RELEASE_TAG..HEAD" --grep="$section_label" --no-merges --decorate --decorate-refs=refs/issues)
+            # If there are commit messages, append the section to the changelog file
+            if [ -n "$commit_messages" ]; then
+              echo "### $section_icon $section_title" >> "$CHANGELOG_FILE"
+              echo "" >> "$CHANGELOG_FILE"
+              echo "$commit_messages" >> "$CHANGELOG_FILE"
+              echo "" >> "$CHANGELOG_FILE"
+            fi
+          }
+          # Append sections to the changelog file based on labels
+          append_section "Bug Fixes" "$LABEL_BUG" "🐞"
+          append_section "New Features" "$LABEL_FEATURE" "⭐️"
+          append_section "Enhancements" "$LABEL_ENHANCEMENT" "✨"
+          append_section "Documentation" "$LABEL_DOCS" "📚"
+          append_section "Refactorings" "$LABEL_REFACTOR" "🔨"
+          append_section "Chores" "$LABEL_CHORE" "⚙️"
+          append_section "Breaking Changes" "$LABEL_BREAKING_CHANGE" "💥"
+          echo "::set-output name=changelog_file::$CHANGELOG_FILE"
+
+      # Read changelog contents into a variable
+      - name: Read Changelog Contents
+        id: read_changelog
+        run: |
+          echo "::set-output name=changelog_contents::$(cat /home/runner/work/changelog.txt)"
+      
+      # Display changelog
+      - name: Display Changelog
+        run: cat /home/runner/work/changelog.txt
+
+      # Attach changelog as an artifact
+      - name: Attach Changelog to Release
+        uses: actions/upload-artifact@v2
+        with:
+          name: Changelog
+          path: /home/runner/work/changelog.txt
+
+      # Create release while including the changelog
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.bump_version.outputs.new_version }}
+          release_name: ${{ steps.bump_version.outputs.new_version }}
+          body_path: /home/runner/work/changelog.txt
+          draft: false
+          prerelease: false