Create a single DOCX file for every TeX document and optimize pipeline #84
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit f8ca3b0.
Witiko
changed the title
danopolan
approved these changes
Jul 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes the following changes:
example-document.docxfrom this repository after this change.ghcr.io/istqborg/istqb_product_base(seeDockerfile) that is used in CI runs.README.md.main, only build TeX documents that were added or modified or that use new/modified files.(epub|html)-output == trueorversion == "release". Build TeX documents to DOCX only when the document metadata containsdocx-output == trueorversion != "release".Furthermore, this PR translates the CI workflows from simple shell scripts to a full-fledged Python program. In the future, this will allow us to implement more complex validation of documents and also more complex logic that decides whether a document should be compiled or not. This will result in greater overall speed of the CI and the document preparation workflow.
Ideally, after this PR, the only visible change for authors should be faster CI, the ability to build locally, and more useful DOCX documents. However, this PR makes major changes to the CI infrastructure and regressions should be expected. Furthermore, I will be away the next week, so any potential fixes will need to wait until July 22. On the other hand, I tested the code from this PR manually against different ISTQB repositories and I did not notice any issues. Therefore, I don't expect any regressions that would be fatal and block authors and I recommend to merge the PR now.
This PR closes #49 and #80.