-
Notifications
You must be signed in to change notification settings - Fork 10
GitHub Actions Workflows
Dominique edited this page Sep 28, 2024
·
3 revisions
This repository is set up in such a way that
- All changes to the LaTeX documents must be submitted in the form of pull requests.
- Pull requests will trigger continuous integration workflows that
- Compile the main document(s).
- Compile a diff using
latex-diff
, which will produce a PDF that highlights the changes. - Report the potential semantic errors identified by
chktex
. - Report the potential grammar and spelling errors identified by
ltex
andtextidote
.
- Pull requests will be commented on and reviewed as they would be in any other GitHub project.
- Merging a pull requests triggers other GitHub Actions workflows:
- The
latexindent
workflow, which will open a new pull request if it identifies any LaTeX code that does not adhere to the formatting specification in the configuration file (localSettings.yaml
). - The
bibtools
workflow, which will open a new pull request if it identifies any code in the BibTeX files that does not adhere to the formatting specification in the configuration file (local.rsc
). - Other workflows to come.
- The
Before submitting a pull request, an author is expected to have reviewed the chktex
, ltex
and textidote
comments locally, and to have addressed them.
He/She is also expected to have run latexindent
locally and formatted the documents according to the latexindent
configuration file.
It is the pull request author’s responsibility to address all comments raised by chktex
, ltex
, and textidote
in a pull request.