Continuous integration

Continuous Integration (CI) tests are implemented via GithHub workflows.

Documentation build and deploy

        flowchart TD

subgraph GitHub - neurospin-deepinsight.github.io/nidl
nidl_doc_main["<code>/"]
nidl_doc_stable["<code>/x.x.x"]
end

subgraph GitHub - nidl
DocumentationBuilder["documentation.yml"]
artifacts@{ shape: docs, label: "doc build artifacts" }
end

DocumentationBuilder -- on main --> nidl_doc_main
DocumentationBuilder -- on GitHub release ---> nidl_doc_stable
DocumentationBuilder -- on PR --> artifacts


    

The development docs are built using GitHub Actions.

The workflow .github/workflows/documentation.yml builds the doc and deploy it to https://neurospin-deepinsight.github.io/nidl on the dev (respectively stable).

On pull-request a successful build of the doc by .github/workflows/documentation.yml has no trigger.

GitHub Actions Specification

documentation.yml

Workflow file: documentation.yml

Workflow to build the documentation.

• check the quality of the doc strings.

• build doc and upload it as artifact.

To run this check locally from the doc folder:

$ cd ./doc
$ make html-strict

linters.yml

Workflow file: linters.yml

Workflow to check code format.

To run this check locally from the repository folder:

$ ruff check nidl

testing.yml

Workflow file: testing.yml

Workflow to check code using unit tests.

To run this check locally from the repository folder:

$ nosetests --with-coverage --cover-package=nidl --verbosity=2