In the GitHub Actions build, this generates the .pdf documentation from the .odt files, uploads them as an artifact, and then downloads them so they can be used in the installed package.
Checklist
[x] Documentation has been updated to reflect the changes made in this pull request.
[x] Code follows the project's coding conventions and style guidelines.
Related Issues
40
Additional Notes
The PDFs are generated every time the workflow is run.
Ideally we would cache the generated pdfs and only regenerate them if the .odt files have changed.
As it runs on ubuntu-latest we would set enableCrossOsArchive to true in the cache action.
The cache key should include the hash of oolite/Doc/ and the hash of this workflow file.
Unfortunately I cannot get the hash of either the oolite/Doc/ folder or the .odt files to match on both Ubuntu and Windows runners.
I suspect that the line endings are different on the two systems, but have failed to find a way to fix this.
Generate the PDF documentation
Pull Request Type
Description
In the GitHub Actions build, this generates the .pdf documentation from the .odt files, uploads them as an artifact, and then downloads them so they can be used in the installed package.
Checklist
Related Issues
40
Additional Notes
The PDFs are generated every time the workflow is run. Ideally we would cache the generated pdfs and only regenerate them if the .odt files have changed. As it runs on ubuntu-latest we would set enableCrossOsArchive to true in the cache action. The cache key should include the hash of oolite/Doc/ and the hash of this workflow file. Unfortunately I cannot get the hash of either the oolite/Doc/ folder or the .odt files to match on both Ubuntu and Windows runners. I suspect that the line endings are different on the two systems, but have failed to find a way to fix this.