Skip to content

Commit

Permalink
Update docs for self-hosted runners
Browse files Browse the repository at this point in the history
  • Loading branch information
ElliottKasoar committed Dec 13, 2024
1 parent d746d73 commit a08d7e1
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/source/developer_guide/ci.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
======================
Continuous Integration
======================

General instructions for setting up self-hosted GitHub runners can be found `here <https://docs.github.com/en/actions/hosting-your-own-runners>`_.

This process typically involves:

1. Add a new self-hosted runner on GitHub
2. Run instructions from GitHub on your runner to download and configure
3. Ensure tags added to the runner are unique, and match those in ``runs-on`` within the CI workflow


MacOS self-hosted runner
========================

Currently, ``janus-core`` uses a self-hosted runner to run all unit tests on MacOS.

To ensure the self-hosted runner remains active, we currently recommend using

.. code-block:: bash
nohup ./run.sh &!
This runs the script in the background, and disowns the process, allowing the ssh connection to be ended without killing the process.

It would be preferable to `configure the runner application as a service <https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service?platform=mac>`_,
but currently this appears to lead to difficulties if the GUI is not active
and/or ``sudo`` permissions are not used in running the service.
1 change: 1 addition & 0 deletions docs/source/developer_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Developer guide

get_started
tutorial
ci

0 comments on commit a08d7e1

Please sign in to comment.