feat: submit changed pages to IndexNow after deploy #603
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Customized workflow for building and deploying a VitePress site to GitHub Pages | |
| name: Deploy VitePress site to Pages | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| # Separate group per ref so PR build checks never queue ahead of a production | |
| # deploy (they previously shared one serialized `pages` group). PRs cancel | |
| # their own superseded runs; pushes to main never cancel an in-progress deploy. | |
| group: pages-${{ github.ref }} | |
| cancel-in-progress: ${{ github.event_name == 'pull_request' }} | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: 22 | |
| - name: Setup Bun | |
| uses: oven-sh/setup-bun@v2 | |
| with: | |
| bun-version: 1.3.11 | |
| - name: Check Bun version | |
| run: bun --version | |
| - name: Setup GitHub Pages | |
| uses: actions/configure-pages@v6 | |
| - name: Install dependencies | |
| run: bun install --frozen-lockfile | |
| - name: Build VitePress site | |
| run: bun run docs:build | |
| - name: List build directory contents | |
| run: ls -la docs/.vitepress/dist | |
| - name: Upload site artifact | |
| uses: actions/upload-pages-artifact@v5 | |
| with: | |
| path: docs/.vitepress/dist | |
| deploy: | |
| if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v5 | |
| indexnow: | |
| # Ping IndexNow with the pages changed in this push so Bing-family engines | |
| # (Bing/Copilot/ChatGPT search, Yandex, etc.) recrawl them quickly. | |
| # Google does not use IndexNow. The key is public by design; it must match | |
| # docs/public/<key>.txt served at the site root. | |
| if: github.event_name == 'push' | |
| needs: deploy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Submit changed URLs to IndexNow | |
| env: | |
| INDEXNOW_KEY: 4c037b783fbf7d87c71f574bef22136f | |
| HOST: airpodsreplicas.com | |
| run: | | |
| BEFORE="${{ github.event.before }}" | |
| # Force pushes and new branches have a null/unknown before SHA; | |
| # fall back to just the head commit's changes. | |
| if [ -z "$BEFORE" ] || ! git cat-file -e "$BEFORE" 2>/dev/null; then | |
| BEFORE="${{ github.sha }}^" | |
| fi | |
| # Map changed markdown pages to their cleanUrls form: index.md becomes | |
| # the directory URL (trailing slash, matching sitemap canonicals), | |
| # other pages drop the .md extension. Deleted pages are submitted too — | |
| # IndexNow recrawls them and drops them from the index. | |
| urls=$(git diff --name-only "$BEFORE" "${{ github.sha }}" -- docs/ \ | |
| | grep '\.md$' \ | |
| | grep -v -e '^docs/\.vitepress/' -e '^docs/public/' \ | |
| | sed -E "s|^docs/||; s|index\.md$||; s|\.md$||; s|^|https://$HOST/|" \ | |
| | sort -u) | |
| if [ -z "$urls" ]; then | |
| echo "No doc pages changed; skipping IndexNow ping." | |
| exit 0 | |
| fi | |
| echo "Submitting $(printf '%s\n' "$urls" | wc -l | tr -d ' ') URL(s) to IndexNow:" | |
| printf '%s\n' "$urls" | |
| payload=$(printf '%s\n' "$urls" | jq -R . | jq -s --arg host "$HOST" --arg key "$INDEXNOW_KEY" \ | |
| '{host: $host, key: $key, keyLocation: "https://\($host)/\($key).txt", urlList: .}') | |
| status=$(curl -sS -o /tmp/indexnow-response.txt -w '%{http_code}' \ | |
| -X POST 'https://api.indexnow.org/indexnow' \ | |
| -H 'Content-Type: application/json; charset=utf-8' \ | |
| -d "$payload") | |
| echo "IndexNow response: HTTP $status" | |
| cat /tmp/indexnow-response.txt || true | |
| # 200 = OK, 202 = accepted (key validation pending) | |
| if [ "$status" != "200" ] && [ "$status" != "202" ]; then | |
| exit 1 | |
| fi |