When should docs build
Closed this issue · 2 comments
coretl commented
3ecf702 made them run on every push and PR, with docs pushed to gh-pages on push. This has 3 issues:
- Duplicate runs of docs builds for PRs from internal branches (can fix with if statement like in code.yaml)
- Internal branch pushes will create new directories in gh-pages which are never deleted
- Still can't see docs output from external repositories
I assume the change was made so you can see the docs output of a branch/PR. If so, we could fix in a few ways:
- Keep this change, but add a new
on: branch: delete
workflow that removes the corresponding directory from gh-pages when a branch is deleted - Keep the change, but only publish to gh-pages on push to selected branches/tags, and always build the docs and upload as an artifact so reviewers can see it
- Do both
gilesknap commented
I quite like just 1 so as not to use up (free) file space on out of date information.