Skip to content

Use the Read the Docs Generic API build trigger - #269

Merged
amol- merged 2 commits into
masterfrom
amol/readthedocs-trigger-diagnostics
Oct 30, 2026
Merged

amol- merged 2 commits into
masterfrom
amol/readthedocs-trigger-diagnostics

Conversation

@amol-

@amol- amol- commented Oct 28, 2026 •

Copy link
Copy Markdown
Collaborator

Replace GitHub-event signing with Read the Docs’ documented Generic API integration:
https://docs.readthedocs.com/platform/stable/guides/setup/git-repo-manual.html#webhook-integration-generic

  • Send a form POST with the repository-secret token, branches=master, and default_branch=master.
  • Remove the Python signing code and pending diagnostic expansion.
  • Preserve step-scoped credentials, canonical master-push restrictions, and all existing runtime and HTML/PDF checks.
  • Fail on HTTP errors or a receipt that does not confirm a build was triggered.

Validation: curl boundary tests cover form encoding, request parameters, credential privacy, HTTP/network/timeout failures, and receipt handling. Gating, YAML/Bash/actionlint and whitespace checks passed. Code-quality review approved the corrected request.

Verified after merge:

@amol- amol- changed the title Show safe diagnostics when Read the Docs declines a build Use the Read the Docs Generic API build trigger Oct 28, 2026
@amol-
amol- merged commit ef06437 into master Oct 30, 2026
8 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