Description of current CI workflow.
Retrieves dynamically generated content from external sources.
Currently retrieves:
- Software module list from modules-list.
- Glossary, spellcheck dictionary and snippets from nesi-wordlist
It then runs link_apps_pages.py.
All modified files are added to a new branch called new-assets
and merged into main.
In theory, all this could be done at deployment, but I wanted to make sure that changes to these remote files didn't break anything.
A Python script used to add a link to the appropriate documentation to modules-list.json.
The script checks all titles of input files, and sets the support
key to be equal to the pages url.
It also adds whatever tags are on that page to the domains
key.
One day I would like to simplify this whole thing.
A series of QA checks run on the documentation.
The checks can be started manually from the , select the target branch, give the pattern of files to include, and select which checks you want done.
Checks will also be run on any non main branch pushes. All checks will be run, but only on changed files.
More info on what these checks do in README.md
Runs on push to main branch. Builds and deploys pages.