There are several helpful links in the header and footer of the website, but I could not quickly find a way to get to the VRapeutic GitHub repositories from the docs site. Since this is a huge plus and it is something people will want to see, it is definitely worth making sure your GitHub is present on the website. 😀

This problem happens whenever the main branch is deployed

Summary

CI checks will not run on Pull Requests, but instead only run on changes in the main branch.

Background

The current Circle CI config is a single-job workflow (build_and_deploy). There is a filter so the job only runs on commits in the main branch. This is good for deploying new changes to your documentation, but we lose the benefit of making sure the documentation site still builds OK on new changes not yet merged to master.

The solution is to split the single job, build_and_deploy, into two separate jobs: build and deploy.

Details

We need two jobs, one to build the Docusaurus site that runs on all changes, and another job to deploy the built site source only for changes added to main branch. The workflows part of the Circle CI config.yml might look like this:

workflows:
  main:
    jobs:
      - build
      - deploy:
          filters:
            branches:
              only: main
          requires:
            - build

Then you need to split it into two jobs. You will need to use persist_to_workspace and attach_workspace to pass the built HTML artifacts from one job to another.

See FOSSRIT/[email protected]/config.yml and FOSSRIT/[email protected]/deploy.sh for examples of this full workflow.

Outcome

All new changes are always confirmed to build successfully, instead of discovering a change doesn't work after getting it into main