Provides a Codespace that can be used to browse files and get a shell on a GitHub actions runner.
This project can be used together with:
More information about that action can be found in the Readme.md of that project.
This project can also be used to start a shell on an GitHub actions runner. The first step is to start a codespace for this project. Once the codespace is started you can start a shell on a runner by running one the following command:
- start-ubuntu
- start-ubuntu-20
- start-ubuntu-24
- start-macos
- start-macos-12
- start-macos-13
- start-windows
These commands will start a workflow in this project and that require the following secrets to be set in the repository:
TOKEN_FOR_ACTIONS
: GitHub token with the following permissions: Full control of private repositories (repo).
This action will start a workflow that will start a runner and tries to connect to codespace of this project. This action requires a secret token with the following name:
TOKEN_FOR_CODESPACES
: GitHub token with the following permissions: Full control of codespaces (codespace).
Once the runner is connected to the codespace you will see the following message in the codespace;
You can now start a shell on the runner by running the shell
command:
/workspaces/runner-codespace # start-ubuntu
/workspaces/runner-codespace # shell
Warning: Permanently added '[localhost]:4748' (ED25519) to the list of known hosts.
runner@fv-az530-702:~/work/runner-codespace/runner-codespace$ uname -a
Linux fv-az530-702 6.5.0-1021-azure #22~22.04.1-Ubuntu SMP Tue Apr 30 16:08:18 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
runner@fv-az530-702:~/work/runner-codespace/runner-codespace$
Once you are done with the runner you can disconnect from the runner by running the exit
command. You can then stop the runner by running the stop-runner
command:
runner@fv-az530-702:~/work/runner-codespace/runner-codespace$ exit
logout
Connection to localhost closed.
/workspaces/runner-codespace # stop-runner
Once you are done with the codespace of this project you can stop it by running the stop-codespace
command:
/workspaces/runner-codespace # stop-codespace