-
Notifications
You must be signed in to change notification settings - Fork 1
feat(seo): IndexNow submissions for changed pages #11202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9b33537
feat(seo): IndexNow — push changed page URLs to Bing, Yandex, Seznam,…
MarkusNeusinger 3107757
docs(workflow): name the three places the IndexNow key lives
MarkusNeusinger a4ae1b6
ci(indexnow): bound the submission curl with a timeout and retries
MarkusNeusinger 950c1c7
ci(indexnow): derive the full URL list from the checkout, handle mult…
MarkusNeusinger acbd5c4
ci(indexnow): a spec change submits its implementation pages; wait fo…
MarkusNeusinger File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| name: "SEO: IndexNow submit" | ||
| run-name: "IndexNow: ${{ github.event_name == 'workflow_dispatch' && inputs.scope || 'changed' }} URLs" | ||
|
|
||
| # Tells the IndexNow engines (Bing, Yandex, Seznam, Naver, Yep) which pages | ||
| # changed, instead of waiting for their next crawl. Google does not take part; | ||
| # it keeps reading the sitemap. | ||
| # | ||
| # On every push to main that touches plots/, the diff is mapped to page URLs: | ||
| # plots/<spec>/specification.* → https://anyplot.ai/<spec> | ||
| # plots/<spec>/metadata/<lang>/<lib>.yaml → https://anyplot.ai/<spec>/<lang>/<lib> | ||
| # plots/<spec>/implementations/<lang>/<lib>.<ext> → same page | ||
| # A deleted implementation is submitted too — IndexNow is "this URL changed", | ||
| # which covers removals. | ||
| # | ||
| # The key is public by design: it only proves the submitter controls the host, | ||
| # and the engines verify it by fetching https://anyplot.ai/<key>.txt. The same | ||
| # key appears in three places — app/public/<key>.txt (the file itself), the | ||
| # exact-match `location` in app/nginx.conf (so a crawler UA is not proxied to | ||
| # /seo-proxy and a 404), and INDEXNOW_KEY below. Keep all three in sync when | ||
| # rotating it. | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - 'plots/**' | ||
| workflow_dispatch: | ||
| inputs: | ||
| scope: | ||
| description: "'changed' submits the URLs touched by the latest commit on main; 'sitemap' submits every URL in the live sitemap (initial load, or after a long outage)" | ||
| required: false | ||
| default: changed | ||
| type: choice | ||
| options: [changed, sitemap] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| concurrency: | ||
| group: indexnow-submit | ||
| cancel-in-progress: false | ||
|
|
||
| env: | ||
| HOST: anyplot.ai | ||
| INDEXNOW_KEY: anyplot-indexnow-ab738f04ea92446a | ||
| SCOPE: ${{ github.event_name == 'workflow_dispatch' && inputs.scope || 'changed' }} | ||
|
|
||
| jobs: | ||
| submit: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| # HEAD~1 is the previous main for a squash merge, which is how every | ||
| # pipeline PR lands; a rare multi-commit push submits its last commit. | ||
| fetch-depth: 2 | ||
|
MarkusNeusinger marked this conversation as resolved.
|
||
|
|
||
| - name: Collect URLs | ||
| id: urls | ||
| env: | ||
| # Number of commits in the push; a squash merge is exactly one. | ||
| PUSH_COMMITS: ${{ github.event_name == 'push' && toJSON(github.event.commits) || '[]' }} | ||
| run: | | ||
| set -euo pipefail | ||
| # The full list comes from the checkout, not from the live sitemap: | ||
| # every spec directory is a hub page and every metadata file an | ||
| # implementation page (the same rule the sitemap follows), plus the | ||
| # static pages. No fetch means no Cloudflare edge or bot management | ||
| # between a GitHub runner and the list, and the shallow checkout | ||
| # still carries the complete tree. | ||
| full_list() { | ||
| for p in / /plots /specs /libraries /map /palette /about /mcp /legal /stats; do | ||
| echo "https://${HOST}${p}" | ||
| done | ||
| git ls-tree -d --name-only HEAD plots/ | awk -F/ '{ print "https://'"$HOST"'/" $2 }' | ||
| git ls-tree -r --name-only HEAD plots/ | awk -F/ ' | ||
| $3 == "metadata" && NF == 5 { lib = $5; sub(/\.[^.]+$/, "", lib); print "https://'"$HOST"'/" $2 "/" $4 "/" lib }' | ||
| } | ||
| commits=$(jq 'length' <<<"$PUSH_COMMITS") | ||
| if [ "$SCOPE" = "sitemap" ]; then | ||
| full_list | sort -u > urls.txt | ||
| elif [ "$commits" -gt 1 ]; then | ||
| # A multi-commit push (rare on main) is not what fetch-depth 2 can | ||
| # diff; submitting everything is cheap and always correct. | ||
| echo "::notice::push carries ${commits} commits; submitting the full list instead of a diff" | ||
| full_list | sort -u > urls.txt | ||
| else | ||
| # A changed specification touches every page of that spec: the | ||
| # implementation pages render the spec's title and description | ||
| # too. A changed implementation or metadata file touches its own | ||
| # page and the hub that lists it. | ||
| impl_pages() { | ||
| git ls-tree -r --name-only HEAD "plots/$1/metadata/" | awk -F/ ' | ||
| NF == 5 { lib = $5; sub(/\.[^.]+$/, "", lib); print "https://'"$HOST"'/" $2 "/" $4 "/" lib }' | ||
| } | ||
| git diff --name-only HEAD~1 HEAD -- plots/ | while IFS=/ read -r top spec third fourth fifth rest; do | ||
| [ "$top" = plots ] && [ -n "$spec" ] && [ -n "$third" ] || continue | ||
| case "$third" in | ||
| specification.*) | ||
| echo "https://${HOST}/${spec}" | ||
| impl_pages "$spec" ;; | ||
| metadata|implementations) | ||
| [ -n "$fifth" ] && [ -z "$rest" ] || continue | ||
| echo "https://${HOST}/${spec}" | ||
| echo "https://${HOST}/${spec}/${fourth}/${fifth%.*}" ;; | ||
| esac | ||
| done | sort -u > urls.txt | ||
| fi | ||
| n=$(wc -l < urls.txt) | ||
| echo "count=$n" >> "$GITHUB_OUTPUT" | ||
| echo "::notice::${n} URL(s) to submit (scope: ${SCOPE})" | ||
| head -20 urls.txt | ||
|
|
||
| - name: Submit to IndexNow | ||
| if: steps.urls.outputs.count != '0' | ||
| run: | | ||
| set -euo pipefail | ||
| # The engines validate a submission by fetching the key file. It is | ||
| # served by the app deploy, which a rollout or a key rotation may | ||
| # still have in flight — wait for it (up to ~8 min), but submit | ||
| # either way: a runner behind Cloudflare's bot management may see a | ||
| # 403 that Bing's own fetch does not, and IndexNow verifies itself. | ||
| for i in $(seq 1 16); do | ||
| if curl -fsS --max-time 15 -o /dev/null "https://${HOST}/${INDEXNOW_KEY}.txt"; then | ||
| echo "::notice::key file reachable"; break | ||
| fi | ||
| if [ "$i" -eq 16 ]; then | ||
| echo "::warning::key file not confirmed reachable after 8 min; submitting anyway" | ||
| else | ||
| sleep 30 | ||
| fi | ||
| done | ||
| # 10,000 URLs per request is the protocol limit; the full sitemap is | ||
| # under that today (4.6k) but the split keeps this future-proof. | ||
| split -l 10000 -d urls.txt batch_ | ||
| for f in batch_*; do | ||
| body=$(jq -n --arg host "$HOST" --arg key "$INDEXNOW_KEY" \ | ||
| --arg loc "https://${HOST}/${INDEXNOW_KEY}.txt" \ | ||
| --rawfile list "$f" \ | ||
| '{host: $host, key: $key, keyLocation: $loc, | ||
| urlList: ($list | split("\n") | map(select(length > 0)))}') | ||
| # Bounded: a slow or flaky api.indexnow.org must not burn the job | ||
| # timeout; three retries cover a transient error, and a transport | ||
| # error after them yields code 000 for the branch below instead of | ||
| # aborting under `set -e`. | ||
| code=$(curl -sS -o response.txt -w '%{http_code}' \ | ||
| --max-time 30 --retry 3 --retry-delay 5 --retry-all-errors \ | ||
| -X POST "https://api.indexnow.org/indexnow" \ | ||
| -H "Content-Type: application/json; charset=utf-8" \ | ||
| --data "$body") || code="000" | ||
| n=$(grep -c . "$f") | ||
| case "$code" in | ||
| 200|202) echo "::notice::IndexNow accepted ${n} URL(s) (HTTP ${code})" ;; | ||
| # 4xx is a protocol or key problem on our side; make it visible. | ||
| 4*) echo "::error::IndexNow rejected ${n} URL(s) (HTTP ${code}): $(head -c 300 response.txt 2>/dev/null)"; exit 1 ;; | ||
| # 5xx / no response: their side. Every later push resubmits its | ||
| # own URLs and `scope=sitemap` covers a longer gap, so warn. | ||
| *) echo "::warning::IndexNow unavailable (HTTP ${code}) for ${n} URL(s); resubmit with scope=sitemap if it persists" ;; | ||
| esac | ||
| done | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| anyplot-indexnow-ab738f04ea92446a |
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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.