beyond-all-reason / beyond-all-reason/RecoilEngine
[Docs] Publish to site should fail if docgen does
- Dominant language
- C++
- Stars
- 679
- Forks
- 290
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 40
Description
See [this action run](https://github.com/beyond-all-reason/spring/actions/runs/14276569071/job/40020490723).
Note emmylua_doc_cli has failed to generate docs from the templates. This caused all documentation to be removed from the normal site display.
If we can detect docgen to fail, we shouldn't publish site. Better older documentation than none
Contributor guide
Research direction
Start with the GitHub Actions workflow used by the linked action run and trace how emmylua_doc_cli reports failure before the site is published. Done means a documentation-generation failure prevents publishing and leaves the previous site documentation available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, lua
- Domain
- ci-cd, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100