Sphinx Deployment Test

This repository is used to test the build and deployment of NIU's Sphinx websites.

We deploy most of our websites by combining two of our re-usable GitHub Actions in a workflow:

• build_sphinx_docs
• deploy_sphinx_docs

Changes to these actions can potentially affect the deployment of our Sphinx websites. This repository provides a safe environment to test the changes before applying them in production.

Usage

First create a Draft Pull Request (PR) to our actions repository with your desired changes. Let's assume the branch of your PR is my-changes.

Then, edit the workflow file in this repository. Replace the respective action links with:

- uses: neuroinformatics-unit/actions/build_sphinx_docs@my-changes
# and/or
- uses: neuroinformatics-unit/actions/deploy_sphinx_docs@my-changes

Make sure the rest of the workflow closely reflects the CI workflows used in production.

Finally, push the changes to this repository and wait for the build step to successfully complete in CI. If you also want to test the deployment step, you may need to trigger it via manual workflow dispatch or via pushing a tag to the main branch (depending on the workflow configuration).

You may also examine the deployed test website at http://neuroinformatics.dev/sphinx-deployment-test/