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

Add cron-like docs-build workflow #739

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

staticdev
Copy link
Contributor

@staticdev staticdev commented Dec 22, 2021

  • Here is the implementation of my proposed solution with addition of some of suggestions from @cjolowicz in our discussion on the issue.
  • It has a CRON job trigger every week and also runs when there are changes on /docs and .rst files.
  • It is on a separate workflow just for docs and so I could remove docs-build and upload from tests workflow.
  • I've been testing it on a project running everyday and seems to work well.
  • I had to ignore some local generated files because of a bug on Sphinx linkcheck Linkcheck marks local links broken when they reference files produced later, during in HTML building sphinx-doc/sphinx#9383
  • Extra: I changed the "Read the Docs" badge to show the status of the new GA workflow in an attempt to have a fail faster approach and visibility of this weekly CRONjob.

Update: user guide needs to be addressed on a new PR on cookiercutter repo.

Closes cjolowicz/cookiecutter-hypermodern-python#901

@staticdev staticdev changed the title Add cron-like docs-build workflow WIP: Add cron-like docs-build workflow Dec 22, 2021
@staticdev staticdev changed the title WIP: Add cron-like docs-build workflow Add cron-like docs-build workflow Dec 22, 2021
@staticdev
Copy link
Contributor Author

staticdev commented Jan 10, 2022

@cjolowicz could review current state here? From my side it is complete.

@cjolowicz
Copy link
Owner

Hey @staticdev thanks for working on this, it's on my radar, just haven't gotten around to reviewing it yet.

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.

Move linkcheck to a cronjob-style workflow
2 participants