Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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: learnthis-is-githubthe-actions
    runworkflow-name:  ${{ github.actor }} is learning GitHub Actions # Pick a name you like.
    on: [push]
    jobs:
      checkthis-is-bats-version:
        runs-on: ubuntu-latestthe-job-name:     steps:      # -Pick uses: actions/checkout@v4
     a name you like.
        runs- useson: actions/setupself-node@v3hosted
            withsteps:
              node-version: '14'- uses: actions/checkout@v4
          - run: npmecho install -g bats
          - run: bats -v
    "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. In this example, check-bats-version is an arbitrary job name. You may select whatever job name is appropriate for your repo. You may create more than one job, which will perform multiple actions on multiple runners.

  • If you need have different branches trigger different runners on different machines, see an example at: https://github.com/Tufts-Technology-Services/dbaadmin-scripts/tree/develop/.github/workflows

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

    • For a list of github cloud-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. You may specify any combination of tags you wish. Your job will only run on runners that satisfy all the tags. For example, if you specify self-hosted then your job will run on any self-hosted runner. If you specify self-hosted, rhel-8 it will only run on those ones.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 runnerrunner, please see 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.