Merge branch 'base-challenge-template' of github.com:scaffold-eth/se-2-challenges into challenge-stablecoins

Author: rin-st

.github/Revalidation.md

@@ -0,0 +1,75 @@
+# GitHub Actions Setup
+
+## README Revalidation Workflow
+
+This repository includes a GitHub Action that automatically revalidates challenge README files on speedrunethereum.com whenever they are updated.
+
+### How it works
+
+The workflow (`revalidate-challenge-readme.yml`) triggers when:
+
+1. **Push events** that modify README files on challenge branches
+2. **Merged pull requests** that modify README files targeting challenge branches
+
+**Watched files:**
+
+- `README.md` (root level challenge description)
+- `extension/README.md.args.mjs` (template file)
+
+**Supported branches:**
+
+- Any branch matching the pattern `challenge-*` (e.g., `challenge-tokenization`, `challenge-decentralized-staking`)
+
+### Setup Requirements
+
+To use this workflow, you need to configure the following repository secret:
+
+#### Required Secret
+
+**`REVALIDATION_TOKEN`**
+
+- Description: Authentication token for speedrunethereum.com API
+- Required for: Making revalidation API calls
+- Setup: Go to your repository Settings → Secrets and variables → Actions → Repository secrets
+
+### How the workflow extracts challenge names
+
+The workflow automatically extracts the challenge name from the branch name:
+
+- `challenge-tokenization` → `tokenization`
+- `challenge-decentralized-staking` → `decentralized-staking`
+- `challenge-dex` → `dex`
+
+This extracted name is used to construct the revalidation URL:
+
+```
+https://speedrunethereum.com/api/revalidate?token=${REVALIDATION_TOKEN}&path=/challenge/${challenge_name}
+```
+
+### Workflow Features
+
+- ✅ **Automatic triggering** on README changes
+- ✅ **Branch pattern matching** for challenge branches only
+- ✅ **Smart challenge name extraction** from branch names
+- ✅ **Error handling** with proper HTTP status checking
+- ✅ **Detailed logging** of revalidation attempts
+- ✅ **GitHub Actions summary** with status and details
+- ✅ **Support for both direct pushes and merged PRs**
+
+### Troubleshooting
+
+If the workflow fails:
+
+1. **Check the secret**: Ensure `REVALIDATION_TOKEN` is correctly set
+2. **Verify branch name**: Make sure you're on a `challenge-*` branch
+3. **Check file paths**: Ensure you're modifying `README.md` or `extension/README.md.args.mjs`
+4. **Review logs**: Check the GitHub Actions logs for detailed error messages
+
+### Testing the workflow
+
+You can test the workflow by:
+
+1. Making a small change to `README.md` on a challenge branch
+2. Committing and pushing the change
+3. Checking the Actions tab in your GitHub repository
+4. Reviewing the workflow run and summary for success/failure status

.github/workflows/revalidate-challenge-readme.yml

@@ -0,0 +1,68 @@
+name: Revalidate Challenge README
+
+on:
+  push:
+    paths:
+      - "README.md"
+    branches:
+      - "challenge-*"
+
+jobs:
+  revalidate:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true)
+
+    steps:
+      - name: Extract challenge name from branch
+        id: extract_challenge
+        run: |
+          # Get the branch name
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            BRANCH_NAME="${{ github.event.pull_request.base.ref }}"
+          else
+            BRANCH_NAME="${{ github.ref_name }}"
+          fi
+
+          # Extract challenge name from branch (e.g., challenge-tokenization -> tokenization)
+          if [[ $BRANCH_NAME =~ ^challenge-(.+)$ ]]; then
+            CHALLENGE_NAME="${BASH_REMATCH[1]}"
+            echo "challenge_name=$CHALLENGE_NAME" >> $GITHUB_OUTPUT
+          else
+            echo "❌ Branch name does not match challenge pattern: $BRANCH_NAME"
+            exit 1
+          fi
+
+      - name: Revalidate speedrunethereum.com
+        if: steps.extract_challenge.outputs.challenge_name != ''
+        run: |
+          CHALLENGE_NAME="${{ steps.extract_challenge.outputs.challenge_name }}"
+
+          RESPONSE=$(curl -s -w "\n%{http_code}" -X POST \
+            "https://speedrunethereum.com/api/revalidate?token=${{ secrets.REVALIDATION_TOKEN }}&path=/challenge/$CHALLENGE_NAME" \
+            -H "Content-Type: application/json")
+
+          HTTP_CODE=$(echo "$RESPONSE" | tail -n1)
+
+          if [ "$HTTP_CODE" -eq 200 ]; then
+            echo "✅ Successfully revalidated challenge $CHALLENGE_NAME"
+          else
+            RESPONSE_BODY=$(echo "$RESPONSE" | head -n -1)
+            echo "❌ Failed to revalidate challenge $CHALLENGE_NAME (HTTP $HTTP_CODE)"
+            echo "Response: $RESPONSE_BODY"
+            exit 1
+          fi
+
+      - name: Add summary
+        if: always()
+        run: |
+          echo "## 📄 README Revalidation" >> $GITHUB_STEP_SUMMARY
+          if [ "${{ steps.extract_challenge.outputs.challenge_name }}" != "" ]; then
+            echo "**Challenge:** \`${{ steps.extract_challenge.outputs.challenge_name }}\`" >> $GITHUB_STEP_SUMMARY
+            if [ "${{ job.status }}" = "success" ]; then
+              echo "✅ Successfully revalidated" >> $GITHUB_STEP_SUMMARY
+            else
+              echo "❌ Failed to revalidate" >> $GITHUB_STEP_SUMMARY
+            fi
+          else
+            echo "❌ Could not extract challenge name from branch" >> $GITHUB_STEP_SUMMARY
+          fi