Skip to content

CI: Submit sitemap after Pages publish - #12

Open
ritorhymes wants to merge 2 commits into
eips-wg:masterfrom
ritovision:feature/sitemap-submit
Open

CI: Submit sitemap after Pages publish#12
ritorhymes wants to merge 2 commits into
eips-wg:masterfrom
ritovision:feature/sitemap-submit

Conversation

@ritorhymes

@ritorhymes ritorhymes commented May 8, 2026

Copy link
Copy Markdown
Contributor

Stacked on V2:20 Roll Out Local Build Workspace for EIPs, which is part of the V2 multi-repo local build system.

Summary

This adds a production-only post-deploy sitemap notification step that submits the generated EIPs sitemap to Google Search Console and IndexNow without blocking Pages deployment if either provider fails.

  • Add scripts/submit-sitemap.py to submit the production sitemap with standard-library Python.
  • Add an IndexNow key-file generation step before the Pages artifact upload.
  • Add a post-deploy submit-sitemap workflow job after GitHub Pages publishing.
  • Gate the feature behind ENABLE_SITEMAP_SUBMIT and github.repository == 'ethereum/EIPs'.
  • Retry each enabled provider once, then warn without failing deploys unless strict mode is enabled.

Deployment Setup

This PR ships dormant until maintainers configure the required repository or organization variables/secrets.

Required for Google Search Console:

  • Verify the https://eips.ethereum.org/ Search Console property.
  • Enable the Search Console API in the Google Cloud project.
  • Configure Google Workload Identity Federation for this repository/workflow; the workflow does not use a long-lived service-account JSON key.
  • Set GOOGLE_WORKLOAD_IDENTITY_PROVIDER.
  • Set GOOGLE_SERVICE_ACCOUNT.
  • Optionally set GOOGLE_SEARCH_CONSOLE_SITE_URL for sc-domain: Search Console properties.
  • Grant the Google identity Owner or Full user access to the Search Console property.

Required for IndexNow:

  • Set INDEXNOW_KEY.
  • The workflow publishes /<INDEXNOW_KEY>.txt into the Pages artifact before deploy.

Required to enable the job:

  • Set ENABLE_SITEMAP_SUBMIT=1.

Validation

  • python3 -m py_compile scripts/submit-sitemap.py
  • Dry run with fake Google and valid IndexNow values
  • No-credentials run exits 0 with provider skip warnings
  • Invalid INDEXNOW_KEY exits 0 with a warning
  • Strict failure against an unreachable local IndexNow endpoint exits nonzero after retry
  • git diff --check

Closes ethereum/EIPs#11298.

ritorhymes added 2 commits May 6, 2026 22:46
@ritorhymes
Roll Out Local Build Workspace for EIPs
8f312d7 
Add the local build workspace metadata and scripts needed to run EIPs
through the workspace-local build pipeline.

Move homepage badges into structured front matter consumed by the theme
renderer.

Include the ERCRef Discord badge in the structured badge list.
@ritorhymes
submit sitemap after publish
beb2478 
Add post-deploy Google Search Console and IndexNow sitemap
notifications to the Pages publishing workflow.

The submit script retries each enabled provider once and defaults to a
non-blocking retry/warn failure policy so deploys remain green unless
strict mode is explicitly enabled.

Gate activation behind the ENABLE_SITEMAP_SUBMIT feature flag and
require repo or org variables/secrets for activation:
GOOGLE_WORKLOAD_IDENTITY_PROVIDER, GOOGLE_SERVICE_ACCOUNT, optional
GOOGLE_SEARCH_CONSOLE_SITE_URL, and INDEXNOW_KEY.
@throwaway-for-circle-ci-bot

throwaway-for-circle-ci-bot commented May 8, 2026 •
edited
Loading

Copy link
Copy Markdown

File .build-eips.repo.toml

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File .github/CONTRIBUTING.md

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File .github/workflows/ci.yml

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File .github/workflows/publish.yml

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File README.md

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File content/_index.md

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File scripts

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File scripts/dev-setup

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File scripts/dev-setup.ps1

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

File scripts/submit-sitemap.py

Requires 2 more reviewers from @g11tech, @jochem-brouwer, @lightclient, @SamWilsn, @xinbenlv

@github-actions github-actions Bot added the w-ci label May 8, 2026
@throwaway-for-circle-ci-bot throwaway-for-circle-ci-bot changed the title Submit sitemap after Pages publish CI: Submit sitemap after Pages publish May 8, 2026
@github-actions

github-actions Bot commented May 8, 2026

Copy link
Copy Markdown

The commit beb2478 (as a parent of ffc1fcb) contains errors.
Please inspect the Run Summary for details.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@throwaway-for-circle-ci-bot throwaway-for-circle-ci-bot Awaiting requested review from throwaway-for-circle-ci-bot throwaway-for-circle-ci-bot is a code owner

At least 0 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

e-consensus w-ci

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Submit updated sitemap to Google / Bing / etc.

2 participants

@ritorhymes @throwaway-for-circle-ci-bot