saltstack / saltstack/salt

[Ops-Impr] Need to get builddocs generative tests, such as Sphinx PDF generation, into GitHub Actions

Open
#59,451 0 comments 0 reactions 2 assignees View on GitHub

@krionbsd is already working on this.

Since Oct 12, 2021.

auto-test ops-improve Phosphorus v3005.0
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 builddocs repo 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.

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.