Page Comparison

...

• In your repo, create a directory called .github/workflows/, and inside there, create an arbitrary named yml file for your workflow. For example, .github/workflows/example-workflow.yml, with code like:

  Code Block
  name: this-is-the-actionworkflow-name # Pick a name you like. on: [push] jobs: this-is-the-job-name: # Pick a name you like. runs-on: self-hosted steps: - uses: actions/checkout@v4 - run: echo "hello world"

• For details on formatting this file, see Understanding GitHub Actions: Understanding the workflow file. For your convenience, highlights are provided here:

• Notice the jobs field contains a hash, or dictionary, of jobs. You may create more than one job, which will perform multiple actions on multiple runners.

• runs-on specifies which runner you wish your job to run on.

  • For a list of github hosted runners in the cloud, see About GitHub-hosted runners

  • For a list of Tufts on-prem locally hosted runners, browse to your repository on GitHub, then click Settings > Actions > Runners. It is NOT recommended to specify a runner by name. Instead, use a tag such as self-hosted or openshift so your job will run on any available self-hosted runner. If you specify a comma-separated list of tags, e.g. self-hosted, rhel-8 it will only run on runners that match all of the tags.

  • If you have special requirements and cannot run your job on a Tufts local runner on shared infrastructure (due to resource or security requirements) please contact it@tufts.edu and request ESCP to setup a private or custom runner, in a restricted Runner Group. Ask them to reference this page: Making a private Github Runner

• uses: actions/checkout@v4 This will checkout your repository in the working directory where the job runs. It is generally recommended to keep this line as-is, unless you have a reason to change it.

• run: lines specify actual commands that will run on the runner. You may specify more than one.

...