Skip to content

GitHub Actions Workflows

Dominique edited this page Sep 28, 2024 · 3 revisions

This repository is set up in such a way that

  1. All changes to the LaTeX documents must be submitted in the form of pull requests.
  2. Pull requests will trigger continuous integration workflows that
    1. Compile the main document(s).
    2. Compile a diff using latex-diff, which will produce a PDF that highlights the changes.
    3. Report the potential semantic errors identified by chktex.
    4. Report the potential grammar and spelling errors identified by ltex and textidote.
  3. Pull requests will be commented on and reviewed as they would be in any other GitHub project.
  4. Merging a pull requests triggers other GitHub Actions workflows:
    1. 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).
    2. 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).
    3. Other workflows to come.

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.

Clone this wiki locally