Skip to content
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

Verify docs were built on RTD before creating a GitHub Release #1186

Merged
merged 1 commit into from
Apr 17, 2023

Conversation

rmartin16
Copy link
Member

@rmartin16 rmartin16 commented Apr 15, 2023

Changes

  • Introduces a dependency on RTD successfully building docs for the new v* tag for creating a GitHub Release.

Implementation

  • When a new v* tag is pushed to the repo, GitHub initiates this repo's release workflow (and in turn the publish workflow as a consequence of a Release being "published").
  • At the same time, presumably through a webhook between GitHub and RTD, the docs for the tag are built on RTD.
  • So, this simply inserts a loop in the release workflow that confirms RTD successfully built the docs for the new version and allows the release process to progress.
    • This checks the built parameter of the payload returned from RTD's version detail endpoint which is defined as "the version has at least one successful build".
    • Since this is the first time RTD has seen the version, a value of true should imply the build that was just triggered completed successfully.
  • As an example, consider the v0.3.14 release from April 11 @ 0311 UTC:

Notes

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@rmartin16 rmartin16 force-pushed the validate-docs-build branch from 9a9d77e to ac063ca Compare April 15, 2023 14:57
Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't really test this without cutting a release; but by inspection, it looks good. If it isn't, I guess I'll frantically fix it when we cut v0.3.15 :-)

@rmartin16 rmartin16 marked this pull request as ready for review April 17, 2023 02:45
@freakboy3742 freakboy3742 merged commit 0e09748 into beeware:main Apr 17, 2023
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.

2 participants