[Ops-Impr] Need to get builddocs generative tests, such as Sphinx PDF generation, into GitHub Actions
@krionbsd is already working on this.
Since Oct 12, 2021.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
This is a follow-up to #59446
- Which was a PR made because of an issue discovered downstream with our
builddocsrepo on GitLab.
Right now, PDF-breaking changes (or EPUB-breaking changes) won't be caught until the pipelines in builddocs launch against the latest updates to the master branch of this repo.
Suggested Fix
Add another docs test, similar to how we test for building the man pages and HTML. We should, at a minimum, include PDF building tests. EPUB builds seem to be more resilient, and would be an optional add. Especially because I don't know what the long-term value of maintaining the EPUB is.
- Dockerfile reference: https://gitlab.com/saltstack/open/docs/builddocs/-/blob/master/container/Dockerfile
- Build job reference: https://gitlab.com/saltstack/open/docs/builddocs/-/blob/master/.gitlab-ci.yml#L53-65
build-pdf.shscript referenced: https://gitlab.com/saltstack/open/docs/builddocs/-/blob/master/build_pdf.shbuild-env.shscript referenced: https://gitlab.com/saltstack/open/docs/builddocs/-/blob/master/build_env.sh
Since builddocs is a public repo, we'd be able to simply git clone it into an action, and run the necessary commands from there.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.