add GH action to auto update GH pages when new release is made

Author: onamfc

.github/link-check-config.json

@@ -0,0 +1,39 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://img\\.shields\\.io/"
+    },
+    {
+      "pattern": "^https://github\\.com/.+/stargazers$"
+    },
+    {
+      "pattern": "^https://github\\.com/.+/network/members$"
+    },
+    {
+      "pattern": "^https://github\\.com/.+/issues$"
+    }
+  ],
+  "httpHeaders": [
+    {
+      "urls": ["https://github.com", "https://api.github.com"],
+      "headers": {
+        "Accept": "application/vnd.github.v3+json",
+        "User-Agent": "link-checker"
+      }
+    }
+  ],
+  "retryOn429": true,
+  "retryCount": 3,
+  "fallbackHttpStatus": [
+    400,
+    401,
+    403,
+    404,
+    408,
+    429,
+    500,
+    502,
+    503,
+    504
+  ]
+}

.github/workflows/deploy-pages.yml

@@ -0,0 +1,61 @@
+name: Deploy to GitHub Pages
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Build with Jekyll
+        run: |
+          bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./_site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+      - name: Comment on Release
+        if: github.event_name == 'release'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.payload.release.id,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `🚀 GitHub Pages has been updated! View the live site: ${{ steps.deployment.outputs.page_url }}`
+            })

.github/workflows/update-progress.yml

@@ -0,0 +1,70 @@
+name: Update Progress Badge
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      week_number:
+        description: 'Week number to update to'
+        required: true
+        type: number
+
+permissions:
+  contents: write
+
+jobs:
+  update-progress:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract week number
+        id: extract_week
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            WEEK_NUMBER="${{ github.event.inputs.week_number }}"
+          else
+            TAG_NAME="${{ github.event.release.tag_name }}"
+            echo "Tag name: $TAG_NAME"
+          
+            # Extract week number from tag (supports formats like "week-5", "v1.5.0", "1.5.0")
+            if [[ $TAG_NAME =~ week-([0-9]+) ]]; then
+              WEEK_NUMBER=${BASH_REMATCH[1]}
+            elif [[ $TAG_NAME =~ v?[0-9]+\.([0-9]+) ]]; then
+              WEEK_NUMBER=${BASH_REMATCH[1]}
+            else
+              echo "Could not extract week number from tag: $TAG_NAME"
+              exit 1
+            fi
+          fi
+          
+          echo "Week number: $WEEK_NUMBER"
+          echo "week_number=$WEEK_NUMBER" >> $GITHUB_OUTPUT
+
+      - name: Update README.md
+        run: |
+          WEEK_NUMBER="${{ steps.extract_week.outputs.week_number }}"
+          sed -i "s/Progress-Week%20[0-9]\+%2F52/Progress-Week%20${WEEK_NUMBER}%2F52/g" README.md
+          sed -i "s/Progress-Week [0-9]\+\/52/Progress-Week ${WEEK_NUMBER}\/52/g" README.md
+
+      - name: Update index.md
+        run: |
+          WEEK_NUMBER="${{ steps.extract_week.outputs.week_number }}"
+          sed -i "s/Progress-Week%20[0-9]\+%2F52/Progress-Week%20${WEEK_NUMBER}%2F52/g" index.md
+          sed -i "s/Progress-Week [0-9]\+\/52/Progress-Week ${WEEK_NUMBER}\/52/g" index.md
+
+      - name: Commit changes
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add README.md index.md
+          if git diff --staged --quiet; then
+            echo "No changes to commit"
+          else
+            git commit -m "Update progress badge to week ${{ steps.extract_week.outputs.week_number }}"
+            git push
+          fi

.github/workflows/validate-links.yml

@@ -0,0 +1,66 @@
+name: Validate Links
+
+on:
+  release:
+    types: [published]
+  schedule:
+    # Run weekly on Sundays at 2 AM UTC
+    - cron: '0 2 * * 0'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  issues: write
+
+jobs:
+  link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check links in README.md
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          config-file: '.github/link-check-config.json'
+          file-path: './README.md'
+
+      - name: Check links in index.md
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          config-file: '.github/link-check-config.json'
+          file-path: './index.md'
+
+      - name: Create issue if links are broken
+        if: failure()
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const title = `🔗 Broken links detected - ${new Date().toISOString().split('T')[0]}`;
+            const body = `
+            ## Broken Links Detected
+            
+            The automated link checker has found broken links in the repository.
+            
+            **Triggered by:** ${{ github.event_name }}
+            **Date:** ${new Date().toISOString()}
+            
+            Please review the workflow logs for details about which links are broken:
+            ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+            
+            ---
+            
+            This issue was automatically created by the link validation workflow.
+            `;
+            
+            github.rest.issues.create({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              title: title,
+              body: body,
+              labels: ['bug', 'documentation']
+            });