Skip to content

ci: build pull request RPC docs from the event commit - #228

Merged
djh58 merged 1 commit into
feature/pq-transportfrom
djh58/rpc-docs-checkout-sha
Oct 6, 2026
Merged

djh58 merged 1 commit into
feature/pq-transportfrom
djh58/rpc-docs-checkout-sha

Conversation

@djh58

@djh58 djh58 commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Summary

The pull request build of the development RPC docs can fail at "Validate version source checkout" with no code problem. #225 hit it: Checked out 967241a7…, expected 792c3c1e….

  • Cause. For a pull request, the build job checks out refs/pull/<n>/merge, then requires it to be the event's merge commit (github.sha). GitHub moves that ref whenever the base branch or the pull request's stack changes. A run that overlaps such a change checks out a newer merge commit and fails.
  • Fix. Check out the event's merge commit by hash, as the release entries already do. The equality check stays, so it now always holds for the commit the event named. The unused --development-checkout-ref plumbing is removed from the workflow and from doc/rpc/versioned_site.py.

Testing

  • Ran focused unit or functional tests for the changed area: python3 -m unittest discover -s test/rpc_docs (27 tests, 1 skipped because MkDocs isn't installed locally). The build-plan test now asserts that the development entry checks out its resolved commit.
  • Ran lint or formatting checks relevant to this change: actionlint on rpc-docs-pages.yml.
  • Not run. Reason: the GitHub-hosted build runs on this PR, because it changes the workflow.

Target Branch

  • This PR targets a maintainer-requested release branch: 1.x.x, the only branch with the versioned RPC docs workflow.

Risk / Review Notes

  • Consensus, script, crypto, wallet, P2P, release, CI, or security-sensitive behavior changed.

Notes: CI only. Pushes to main, releases and manual runs are unchanged; they already checked out by hash.

Docs / Process Impact

  • No docs change needed.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

The pull request build of the development RPC docs checked out
refs/pull/<n>/merge and then required it to be the event's merge commit.
That ref moves whenever the base branch or the pull request's stack
changes, so a run that overlapped such a change checked out a different
merge commit and failed "Validate version source checkout".

Check out the event's merge commit by hash instead, as the release
entries already do, and drop the now unused --development-checkout-ref
plumbing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@djh58
djh58 changed the base branch from 1.x.x to feature/pq-transport October 6, 2026 15:16
@djh58
djh58 requested a review from RobertClarke October 6, 2026 15:18
@djh58
djh58 merged commit 5cbf4e1 into feature/pq-transport Oct 6, 2026
64 of 68 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant