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

Do not release if the docs are not up-to-date #43

Open
ctreatma opened this issue Jul 17, 2024 · 0 comments
Open

Do not release if the docs are not up-to-date #43

ctreatma opened this issue Jul 17, 2024 · 0 comments

Comments

@ctreatma
Copy link
Contributor

This repo and others created from it rely on PRs to generate updated docs. After every PR is merged, the docs update job runs; that job regenerates the docs and opens a PR if any changes are needed.

The PR workflow for docs means that it's possible to release code changes before the corresponding docs changes have been merged. To protect against this, we could update the release workflow to check if the docs are outdated, and fail with an informative error if the docs need changes.

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

No branches or pull requests

1 participant