ci: Fix a11y and other Action workflows (#1299)

Author: DaveSkender

.github/workflows/deploy-package.yml

@@ -7,15 +7,20 @@ on:
         description: Deployment environment
         type: choice
         options:
-          - staging
+          - pkg.github.com
           - nuget.org
-        default: staging
+        default: pkg.github.com
         required: true
       preview:
         description: Append preview suffix
         type: boolean
         default: true
         required: true
+      dry_run:
+        description: 'Dry-run only (no deploy)'
+        type: boolean
+        default: true
+        required: true
 
 concurrency:
   group: ${{ inputs.environment }}
@@ -34,6 +39,12 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: "9.x"
+          dotnet-quality: "ga"
+
       - name: Setup GitVersion
         uses: gittools/actions/gitversion/[email protected]
         with:
@@ -51,21 +62,19 @@ jobs:
       - name: Compose version
         id: compose
         run: |
-          ver=${{ steps.gitversion.outputs.majorMinorPatch }}${{ inputs.preview && '-preview.' || '' }}${{ inputs.preview && steps.gitversion.outputs.preReleaseNumber || inputs.preview && github.run_number || '' }}
-          echo "version=$ver" >> "$GITHUB_OUTPUT"
+          # get base version
+          base="${{ steps.gitversion.outputs.majorMinorPatch }}"
 
-      - name: Update release notes URL
-        uses: jacobtomlinson/gha-find-replace@v3
-        with:
-          find: "<PackageReleaseNotes>https://github.com/DaveSkender/Stock.Indicators/releases</PackageReleaseNotes>"
-          replace: "<PackageReleaseNotes>https://github.com/DaveSkender/Stock.Indicators/releases/tag/${{ steps.compose.outputs.version }}</PackageReleaseNotes>"
-          regex: false
+          # determine preview suffix
+          preview_tag="${{ inputs.preview && '-preview.' || '' }}"
 
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: "9.x"
-          dotnet-quality: "ga"
+          # determine preview number
+          preview_num="${{ inputs.preview && steps.gitversion.outputs.preReleaseNumber || '' }}"
+
+          # combine all parts
+          ver="${base}${preview_tag}${preview_num}"
+
+          echo "version=$ver" >> "$GITHUB_OUTPUT"
 
       - name: Build library
         run: >
@@ -106,28 +115,18 @@ jobs:
   deploy:
     needs: build
     runs-on: ubuntu-latest
+    if: success()
 
     permissions:
       contents: write
       packages: write
 
     environment:
-      name: ${{ inputs.environment }}
-      url: "${{ vars.NUGET_DOWNLOAD_PREFIX }}${{ needs.build.outputs.version }}"
+      name: ${{ !inputs.dry_run && inputs.environment || '' }}
+      url: ${{ steps.package_info.outputs.url }}
 
     steps:
 
-      - name: Pre-flight summary
-        run: |
-          {
-            echo "| Parameter       | Value                              |"
-            echo "| :-------------- | :--------------------------------- |"
-            echo "| Environment     | ${{ inputs.environment }}          |"
-            echo "| Publishing URL  | ${{ vars.NUGET_PUBLISH_URL }}      |"
-            echo "| Download URL    | ${{ vars.NUGET_DOWNLOAD_PREFIX }}  |"
-            echo "| Version ID      | ${{ needs.build.outputs.version }} |"
-          } >> $GITHUB_STEP_SUMMARY
-
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
@@ -146,28 +145,59 @@ jobs:
           name: packages
           path: NuGet
 
-      - name: Publish to GitHub Packages (staging)
-        if: inputs.environment == 'staging'
-        run: |
-            dotnet nuget push NuGet/*.nupkg --source "https://nuget.pkg.github.com/DaveSkender/index.json" --api-key ${{ secrets.GITHUB_TOKEN }} --skip-duplicate
-
-      - name: Publish to NuGet.org
-        if: inputs.environment == 'nuget.org'
+      - name: Compose package info
+        id: package_info
         run: |
-          dotnet new nugetconfig --force
-          nuget setApiKey ${{ secrets.NUGET_TOKEN }} -src nuget -ConfigFile nuget.config
-          nuget push NuGet/*.nupkg -src nuget -NonInteractive -ConfigFile nuget.config -Verbosity Detailed
+          PACKAGE_NAME=$(xmllint --xpath "//PropertyGroup/PackageId/text()" Directory.Build.props || xmllint --xpath "//PropertyGroup/PackageId/text()" **/*.csproj)
+          echo "pkg_name=${PACKAGE_NAME}" >> $GITHUB_OUTPUT
+          if [[ "${{ inputs.environment }}" == "nuget.org" ]]; then
+            echo "pkg_url=https://www.nuget.org/packages/${PACKAGE_NAME}/${{ needs.build.outputs.version }}" >> $GITHUB_OUTPUT
+          else
+            echo "pkg_url=https://github.com/${{ github.repository }}/packages/nuget/${PACKAGE_NAME}/${{ needs.build.outputs.version }}" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish package
+        if: ${{ !inputs.dry_run }}
+        env:
+          API_KEY: ${{ inputs.environment == 'nuget.org' && secrets.NUGET_TOKEN || secrets.GITHUB_TOKEN }}
+        run: >
+          dotnet nuget push NuGet/*.nupkg
+          --source "${{ vars.NUGET_PUBLISH_URL }}"
+          --api-key "$API_KEY"
+          --skip-duplicate
 
       - name: Tag and draft release note
         uses: ncipollo/release-action@v1
-        if: inputs.environment == 'nuget.org'
+        if: ${{ !inputs.dry_run && inputs.environment == 'nuget.org' }}
         with:
           body: |
-            We’ve released a new Stock Indicators for .NET NuGet package.
-            See [Skender.Stock.Indicators @ NuGet.org](${{ vars.NUGET_DOWNLOAD_PREFIX }}${{ needs.build.outputs.version }}) for more information.
+            ## Release ${{ needs.build.outputs.version }}
+
+            📦 Package deployed to [${{ inputs.environment }}](${{ steps.package_info.outputs.pkg_url }})
+
+            ### Package Details
+            - **Name**: ${{ steps.package_info.outputs.pkg_name }}
+            - **Version**: ${{ needs.build.outputs.version }}
+            - **Preview**: ${{ inputs.preview && 'Yes' || 'No' }}
           generateReleaseNotes: true
           draft: true
           makeLatest: ${{ !inputs.preview }}
           prerelease: ${{ inputs.preview }}
-          tag: ${{ needs.build.outputs.version }}
-          commit: ${{ github.ref_name }}
+          tag: v${{ needs.build.outputs.version }}
+          commit: ${{ github.sha }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Deployment summary
+        if: always()
+        run: |
+          {
+            echo "## Package Deployment"
+            echo "| Parameter   | Value |"
+            echo "|:------------|:------|"
+            echo "| Mode        | ${{ inputs.dry_run && '🔍 DRY RUN' || '🚀 DEPLOY' }} |"
+            echo "| Status      | ${{ job.status == 'success' && '✅ Success' || '❌ Failed' }} |"
+            echo "| Environment | ${{ inputs.environment }} |"
+            echo "| Version     | ${{ needs.build.outputs.version }} |"
+            echo "| Package     | [${{ steps.package_info.outputs.pkg_name }}](${{ steps.package_info.outputs.pkg_url }}) |"
+            echo "| Preview     | ${{ inputs.preview && '✓' || '✗' }} |"
+          } >> $GITHUB_STEP_SUMMARY

.github/workflows/deploy-website.yml

@@ -12,10 +12,16 @@ jobs:
   deploy:
     name: Cloudflare Pages
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    env:
+      BUNDLE_GEMFILE: ${{github.workspace}}/docs/Gemfile
+      JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     environment:
       name: stockindicators.dev
-      url: ${{ steps.deploy.outputs.deployment-alias-url }}
+      url: ${{ steps.deploy.outputs.pages-deployment-alias-url }}
 
     steps:
       - name: Checkout source
@@ -24,9 +30,11 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          working-directory: docs
           ruby-version: 3.3
 
+      - name: Install dependencies
+        run: bundle install
+
       - name: Define tag
         id: tag
         run: echo "version=$(date +'%Y.%m.%d')-${{ github.run_number }}" >> $GITHUB_OUTPUT
@@ -38,28 +46,16 @@ jobs:
           replace: "${{ steps.tag.outputs.version }}"
           regex: false
 
-      - name: Install GEMs
-        working-directory: docs
-        env:
-          BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
-        run: |
-          pwd
-          bundle install
-
       - name: Build site (production)
         if: github.ref == 'refs/heads/main'
-        working-directory: docs
         env:
           JEKYLL_ENV: production
-          BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
         run: bundle exec jekyll build
 
       - name: Build site (preview)
         if: github.ref != 'refs/heads/main'
-        working-directory: docs
         env:
           JEKYLL_ENV: preview
-          BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
         run: bundle exec jekyll build
 
       - name: Publish to Cloudflare Pages

.github/workflows/lint-pull-request.yml

@@ -14,6 +14,7 @@ jobs:
   main:
     name: lint PR title
     runs-on: ubuntu-latest
+
     steps:
       - uses: amannn/action-semantic-pull-request@v5
         id: lint_pr_title
@@ -29,9 +30,8 @@ jobs:
           # the default error message that is shown when the pattern doesn't match.
           # The variables `subject` and `title` can be used within the message.
           subjectPatternError: >
-            The subject "**{subject}**" found in the pull request title "*{title}*"
-            didn't match the configured pattern. Please ensure that the subject
-            starts with an uppercase character.
+            The subject "**{subject}**" in pull request "*{title}*"
+            needs to start with an uppercase character.
 
           # If the PR contains one of these newline-delimited labels, the
           # validation is skipped. If you want to rerun the validation when
@@ -48,24 +48,21 @@ jobs:
         with:
           header: pr-title-lint-error
           message: |
-            ### Hey there and thank you for opening this pull request! 👋🏼
-
-            It looks like your proposed **_Pull request title_** needs to be adjusted.
-
-            >🚩 **Error** » ${{ steps.lint_pr_title.outputs.error_message }}
+            ### ⚠️ Pull Request title needs adjustment
 
-            #### Pull request title naming convention
+            Your PR title doesn't match our naming convention: `type: Subject`
 
-            Our PR title name taxonomy is `type: Subject`, where **type** is typically
-            *feat*, *fix*, or *chore*, and **subject** is a phrase (proper noun) that starts
-            with a capitalized letter.  The *chore* type usually has a subject that starts
-            with an action verb like *Add* or *Update*. Examples:
+            > [!CAUTION]
+            > ${{ steps.lint_pr_title.outputs.error_message }}
 
-            - _feat: Admin portal login_
-            - _fix: Divide by zero in X calculation_
-            - _chore: Update packages_
-            - _docs: Improve setup guidance_
+            #### Valid examples
 
+            - `feat: Add new RSI indicator`
+            - `fix: Correct MACD calculation`
+            - `chore: Update documentation`
+            - `test: Add unit tests for EMA`
+            - `refactor: Optimize moving average logic`
+            
             See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information.
 
       # Delete a previous comment when the issue has been resolved

.github/workflows/lock-issues-pr.yml

@@ -16,6 +16,8 @@ concurrency:
 jobs:
   lock:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
+
     steps:
       - uses: dessant/lock-threads@v5
         with:

.github/workflows/test-website-a11y.yml

@@ -4,19 +4,23 @@ on:
   pull_request:
     branches: ["*"]
     paths:
-      - 'docs/**'
-      - ".github/workflows/test-website-a11y.yml"
+      - docs/**
+      - .github/workflows/test-website-a11y.yml
 
-env:
-  JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+# Prevent multiple concurrent runs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   test:
-    name: test
     runs-on: ubuntu-latest
-
+    defaults:
+      run:
+        working-directory: docs
     env:
-      BUNDLE_GEMFILE: ${{github.workspace}}/docs/GemFile
+      BUNDLE_GEMFILE: ${{github.workspace}}/docs/Gemfile
+      JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
       - name: Checkout source
@@ -25,33 +29,34 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          working-directory: docs
           ruby-version: 3.3
 
-      - name: Install GEMs
-        working-directory: docs
+      - name: Install dependencies
         run: |
-          pwd
           bundle install
+          npm install -g pa11y-ci
+
+      - name: Use 'localhost'
+        uses: jacobtomlinson/gha-find-replace@v3
+        with:
+          find: "https://dotnet.stockindicators.dev"
+          replace: "http://127.0.0.1:4000"
+          regex: false
 
       - name: Build site
-        working-directory: docs
         run: bundle exec jekyll build
 
       - name: Serve site
-        working-directory: docs
-        run: bundle exec jekyll serve --detach
+        run: bundle exec jekyll serve --port 4000 --detach
 
       - name: Show environment
-        working-directory: docs
         run: npx pa11y --environment
 
       - name: Test accessibility
-        working-directory: docs
-        run: |
-          npx pa11y-ci \
-            --sitemap http://127.0.0.1:4000/sitemap.xml \
-            --sitemap-exclude "/*.pdf"
+        run: >
+          pa11y-ci
+          --sitemap http://127.0.0.1:4000/sitemap.xml
+          --config ./.pa11yci
 
       - name: Kill site (failsafe)
         if: always()