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

Test all pull requests for docs #536

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

dancergraham
Copy link
Contributor

@dancergraham dancergraham commented Nov 26, 2024

This workflow runs against all PRs to catch problems with docs. It catches any problems before merging to master.

Related to #526

update the CI workflow to include a documentation build stage.

@dancergraham dancergraham changed the title WIP - Test the docs Test the docs Nov 28, 2024
@dancergraham dancergraham requested a review from clintonb December 3, 2024 13:06
Copy link
Collaborator

@clintonb clintonb left a comment

Choose a reason for hiding this comment

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

This should be done for pull requests that touch docs. Finding a failure after merging to master is too late. Can you add a workflow that runs against PRs?

@dancergraham
Copy link
Contributor Author

dancergraham commented Dec 4, 2024

This should be done for pull requests that touch docs. Finding a failure after merging to master is too late. Can you add a workflow that runs against PRs?

Hello, this workflow runs against both PRs and on merge - see here
https://github.com/jazzband/django-waffle/actions/runs/12074017053/job/33671235325?pr=536

dancergraham and others added 3 commits December 4, 2024 14:07
Related to jazzband#526

Add a command to build the documentation using Sphinx and update the CI workflow to include a documentation build stage.

* **run.sh**
  - Add a command to build the documentation using Sphinx.
  - Update the usage function to include the new builddocs command.

* **.github/workflows/python-package.yml**
  - Add a new stage to run the documentation building to ensure it works.
  - Update the release-production stage to depend on the new docs stage.
@dancergraham
Copy link
Contributor Author

dancergraham commented Dec 5, 2024

@clintonb could you look again please - I think this PR already does what you are asking for:

  • Without this PR doc building can fail silently on readthedocs.io - the only visible sign will be the new status badge on the readme
  • With this PR the CI will fail before merging if the docs do not build correctly

@dancergraham dancergraham changed the title Test the docs Test all pull requests for docs Dec 20, 2024
@dancergraham
Copy link
Contributor Author

Hi @clintonb I still think this PR does exactly what you are asking for - can you please rephrase if I'm missing something?

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