Redirected from /websites/github_actions
GitHub Actions

https://docs.github.com/en/actions
Admin
GitHub Actions automates, customizes, and executes software development workflows directly in your...
Tokens:559,721
Snippets:4,799
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Build and test Go code with go build and go test

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/go

Example workflow that installs dependencies, then runs `go build -v ./...` and `go test` using the same commands you use locally.

```yaml
name: Go
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.21.x'
      - name: Install dependencies
        run: go get .
      - name: Build
        run: go build -v ./...
      - name: Test with the Go CLI
        run: go test
```

--------------------------------

### Install and upgrade pip, setuptools, and wheel with pip

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/python

Installs or upgrades the pip package installer along with setuptools and wheel on a GitHub-hosted runner. Use this as a starting step before building and testing Python code.

```yaml
steps:
- uses: actions/checkout@v6
- name: Set up Python
  uses: actions/setup-python@v5
  with:
    python-version: '3.x'
- name: Install dependencies
  run: python -m pip install --upgrade pip setuptools wheel
```

--------------------------------

### Check installation with helm list -A

Source: https://docs.github.com/en/actions/tutorials/use-actions-runner-controller/get-started

Run this command to verify the installation; the expected output lists the arc and arc-runner-set releases with deployed status.

```bash
helm list -A
```

```bash
NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                                       APP VERSION
arc             arc-systems     1               2023-04-12 11:45:59.152090536 +0000 UTC deployed        gha-runner-scale-set-controller-0.4.0       0.4.0
arc-runner-set  arc-runners     1               2023-04-12 11:46:13.451041354 +0000 UTC deployed        gha-runner-scale-set-0.4.0                  0.4.0
```

--------------------------------

### Install Go dependencies with go get in a workflow

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/go

Use `go get` in a workflow step to install dependencies, including a specific module version. Requires the `actions/checkout` and `actions/setup-go` steps beforehand.

```yaml
    steps:
      - uses: actions/checkout@v6
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.21.x'
      - name: Install dependencies
        run: |
          go get .
          go get example.com/octo-examplemodule
          go get example.com/octo-examplemodule@v1.3.4
```

--------------------------------

### Install dependencies with setup-ruby and bundle install

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/ruby

The setup-ruby action installs bundler automatically, with the version determined by gemfile.lock (or the latest compatible version if absent). Use this workflow step sequence to check out the repo, set up Ruby 3.1, and run bundle install.

```yaml
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
steps:
- uses: actions/checkout@v6
- uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
  with:
    ruby-version: '3.1'
- run: bundle install
```

--------------------------------

### Start the self-hosted runner service on macOS with ./svc.sh start

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application

Starts the runner service on macOS.

```shell
./svc.sh start
```

--------------------------------

### Annotated example workflow YAML file (learn-github-actions)

Source: https://docs.github.com/en/actions/tutorials/create-an-example-workflow

Complete workflow that triggers on push, runs on ubuntu-latest, checks out the repo, installs Node.js 24, installs the bats testing package, and prints its version. Each line is annotated to explain the YAML syntax.

```yaml
# Optional - The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. If this field is omitted, the name of the workflow file will be used instead.
name: learn-github-actions

# Optional - The name for workflow runs generated from the workflow, which will appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the `github` context to display the username of the actor that triggered the workflow run. For more information, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#run-name).
run-name: ${{ github.actor }} is learning GitHub Actions

# Specifies the trigger for this workflow. This example uses the `push` event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. This is triggered by a push to every branch; for examples of syntax that runs only on pushes to specific branches, paths, or tags, see [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore).
on: [push]

# Groups together all the jobs that run in the `learn-github-actions` workflow.
jobs:

# Defines a job named `check-bats-version`. The child keys will define properties of the job.
  check-bats-version:

# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub. For syntax examples using other runners, see [AUTOTITLE](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
    runs-on: ubuntu-latest

# Groups together all the steps that run in the `check-bats-version` job. Each item nested under this section is a separate action or shell script.
    steps:

# The `uses` keyword specifies that this step will run the `actions/checkout@v6` action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will use the repository's code.
      - uses: actions/checkout@v6

# This step uses the `actions/setup-node@v7` action to install the specified version of the Node.js. (This example uses version 24.) This puts both the `node` and `npm` commands in your `PATH`.
      - uses: actions/setup-node@v7
        with:
          node-version: '24'

# The `run` keyword tells the job to execute a command on the runner. In this case, you are using `npm` to install the `bats` software testing package.
      - run: npm install -g bats

# Finally, you'll run the `bats` command with a parameter that outputs the software version.
      - run: bats -v
```

--------------------------------

### Example Dockerfile for a custom runner image

Source: https://docs.github.com/en/actions/concepts/runners/actions-runner-controller

Use this Dockerfile as a starting point to build your own runner image. Set RUNNER_VERSION and RUNNER_CONTAINER_HOOKS_VERSION to the latest release versions; the runner binary is placed under /home/runner/ and the container hooks under /home/runner/k8s for Kubernetes mode.

```dockerfile
FROM mcr.microsoft.com/dotnet/runtime-deps:6.0 as build

# Replace value with the latest runner release version
# source: https://github.com/actions/runner/releases
# ex: 2.303.0
ARG RUNNER_VERSION=""
ARG RUNNER_ARCH="x64"
# Replace value with the latest runner-container-hooks release version
# source: https://github.com/actions/runner-container-hooks/releases
# ex: 0.3.1
ARG RUNNER_CONTAINER_HOOKS_VERSION=""

ENV DEBIAN_FRONTEND=noninteractive
ENV RUNNER_MANUALLY_TRAP_SIG=1
ENV ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT=1

RUN apt update -y && apt install curl unzip -y

RUN adduser --disabled-password --gecos "" --uid 1001 runner \
    && groupadd docker --gid 123 \
    && usermod -aG sudo runner \
    && usermod -aG docker runner \
    && echo "%sudo ALL=(ALL:ALL) NOPASSWD:ALL" > /etc/sudoers \
    && echo "Defaults env_keep += \"DEBIAN_FRONTEND\"" >> /etc/sudoers

WORKDIR /home/runner

RUN curl -f -L -o runner.tar.gz https://github.com/actions/runner/releases/download/v${RUNNER_VERSION}/actions-runner-linux-${RUNNER_ARCH}-${RUNNER_VERSION}.tar.gz \
    && tar xzf ./runner.tar.gz \
    && rm runner.tar.gz

RUN curl -f -L -o runner-container-hooks.zip https://github.com/actions/runner-container-hooks/releases/download/v${RUNNER_CONTAINER_HOOKS_VERSION}/actions-runner-hooks-k8s-${RUNNER_CONTAINER_HOOKS_VERSION}.zip \
    && unzip ./runner-container-hooks.zip -d ./k8s \
    && rm runner-container-hooks.zip

USER runner
```

--------------------------------

### Example output of configure command

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/gitlab-migration

Shows the interactive prompts and responses when configuring GitHub Actions Importer for GitLab.

```shell
$ gh actions-importer configure
✔ Which CI providers are you configuring?: GitLab
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Private token for GitLab: ***************
✔ Base url of the GitLab instance: http://localhost
Environment variables successfully updated.
```

--------------------------------

### Install the self-hosted runner service on Linux with sudo ./svc.sh install

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application

Stop the runner application first if it is running, then install the service. Requires sudo on Linux.

```shell
sudo ./svc.sh install
```

--------------------------------

### Example journalctl output for a self-hosted runner job

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot

Shows runner01 starting, connecting to GitHub, listening for jobs, running testAction, and reporting the job result as Succeeded.

```shell
Feb 11 14:57:07 runner01 runsvc.sh[962]: Starting Runner listener with startup type: service
Feb 11 14:57:07 runner01 runsvc.sh[962]: Started listener process
Feb 11 14:57:07 runner01 runsvc.sh[962]: Started running service
Feb 11 14:57:16 runner01 runsvc.sh[962]: √ Connected to GitHub
Feb 11 14:57:17 runner01 runsvc.sh[962]: 2020-02-11 14:57:17Z: Listening for Jobs
Feb 11 16:06:54 runner01 runsvc.sh[962]: 2020-02-11 16:06:54Z: Running job: testAction
Feb 11 16:07:10 runner01 runsvc.sh[962]: 2020-02-11 16:07:10Z: Job testAction completed with result: Succeeded
```

--------------------------------

### Example output of the configure command

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/travis-ci-migration

Shows the prompts and values entered when configuring Travis CI, ending with environment variables successfully updated.

```shell
$ gh actions-importer configure
✔ Which CI providers are you configuring?: Travis CI
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Travis CI: ***************
✔ Base url of the Travis CI instance: https://travis-ci.com
✔ Travis CI organization name: actions-importer-labs
Environment variables successfully updated.
```

--------------------------------

### run_container_step example input using a Docker image

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/customize-containers

Example JSON input for run_container_step when specifying a Docker image via the "image" parameter. Includes required workingDirectory and optional fields such as entryPoint, environmentVariables, mounts, and portMappings.

```json
{
  "command": "run_container_step",
  "responseFile": null,
  "state": {
    "network": "example_network_53269bd575972817b43f7733536b200c",
    "jobContainer": "82e8219701fe096a35941d869cf3d71af1d943b5d8bdd718857fb87ac3042480",
    "serviceContainers": {
      "redis": "60972d9aa486605e66b0dad4abb678dc3d9116f536579e418176eedb8abb9105"
    }
  },
  "args": {
    "image": "node:18",
    "dockerfile": null,
    "entryPointArgs": ["-f", "/dev/null"],
    "entryPoint": "tail",
    "workingDirectory": "/__w/octocat-test2/octocat-test2",
    "createOptions": "--cpus 1",
    "environmentVariables": {
      "NODE_ENV": "development"
    },
    "prependPath": ["/foo/bar", "bar/foo"],
    "userMountVolumes": [
      {
        "sourceVolumePath": "my_docker_volume",
        "targetVolumePath": "/volume_mount",
        "readOnly": false
      }
    ],
    "systemMountVolumes": [
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/_work",
        "targetVolumePath": "/__w",
        "readOnly": false
      },
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/externals",
        "targetVolumePath": "/__e",
        "readOnly": true
      },
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/_work/_temp",
        "targetVolumePath": "/__w/_temp",
        "readOnly": false
      },
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/_work/_actions",
        "targetVolumePath": "/__w/_actions",
        "readOnly": false
      },
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/_work/_tool",
        "targetVolumePath": "/__w/_tool",
        "readOnly": false
      },
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/_work/_temp/_github_home",
        "targetVolumePath": "/github/home",
        "readOnly": false
      },
      {
        "sourceVolumePath": "/home/octocat/git/runner/_layout/_work/_temp/_github_workflow",
        "targetVolumePath": "/github/workflow",
        "readOnly": false
      }
    ],
    "registry": null,
    "portMappings": { "80": "801" }
  }
}
```

--------------------------------

### Install the self-hosted runner service as a different user with ./svc.sh install USERNAME

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application

The install command accepts an optional user argument to install the service as a different user.

```shell
USERNAME
```

--------------------------------

### Install the self-hosted runner service on macOS with ./svc.sh install

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application

Stop the runner application first if it is running, then install the service on macOS.

```shell
./svc.sh install
```

--------------------------------

### startsWith example

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/expressions

Returns true when searchString starts with searchValue. Not case sensitive; casts values to a string.

```javascript
startsWith('Hello world', 'He')
```

--------------------------------

### Create learn-github-actions.yml workflow triggered on push

Source: https://docs.github.com/en/actions/tutorials/create-an-example-workflow

Place this YAML file in the .github/workflows/ directory. It runs on every push, checks out the code, sets up Node.js 24, installs the bats testing framework, and runs `bats -v` to output its version.

```yaml
name: learn-github-actions
run-name: ${{ github.actor }} is learning GitHub Actions
on: [push]
jobs:
  check-bats-version:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: actions/setup-node@v7
        with:
          node-version: '24'
      - run: npm install -g bats
      - run: bats -v
```

--------------------------------

### Example configure command output

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/azure-devops-migration

Shows the interactive prompts and responses when configuring Azure DevOps. The output confirms that environment variables were successfully updated.

```shell
$ gh actions-importer configure
✔ Which CI providers are you configuring?: Azure DevOps
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Azure DevOps: ***************
✔ Base url of the Azure DevOps instance: https://dev.azure.com
✔ Azure DevOps organization name: :organization
✔ Azure DevOps project name: :project
Environment variables successfully updated.
```

--------------------------------

### Create goodbye.sh with example code

Source: https://docs.github.com/en/actions/tutorials/create-actions/create-a-composite-action

Run in the repository to create a `goodbye.sh` script containing an echo command.

```shell
echo "echo Goodbye" > goodbye.sh
```

--------------------------------

### Generate an installation access token for a GitHub App

Source: https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules

Use the installation ID from the `deployment_protection_rule` webhook payload to create an install token. Authenticate with a JWT and request `deployments: write` permission for the specified repository.

```shell
curl --request POST \
--url "https://api.github.com/app/installations/INSTALLATION_ID/ACCESS_TOKENS" \
--header "Accept: application/vnd.github+json" \
--header "Authorization: Bearer {jwt}" \
--header "Content-Type: application/json" \
--data \
'{ \
   "repository_ids": [321], \
   "permissions": { \
      "deployments": "write" \
   } \
}'
```

--------------------------------

### Install dependencies with npm install

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/nodejs

Installs the dependencies defined in the package.json file.

```yaml
steps:
- uses: actions/checkout@v6
- name: Use Node.js
  uses: actions/setup-node@v7
  with:
    node-version: '20.x'
- name: Install dependencies
  run: npm install
```

--------------------------------

### Start the self-hosted runner service on Windows with Start-Service

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application

Starts the runner service on Windows using the actions.runner.* service name pattern.

```shell
Start-Service "actions.runner.*"
```

--------------------------------

### Install rollup and plugins

Source: https://docs.github.com/en/actions/tutorials/create-actions/create-a-javascript-action

Run this command to install rollup and its plugins as dev dependencies. Required before creating the rollup configuration.

```shell
npm install --save-dev rollup @rollup/plugin-commonjs @rollup/plugin-node-resolve
```

--------------------------------

### Install SqlServer and PSScriptAnalyzer modules from PSGallery

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/powershell

Job that trusts the PSGallery repository and installs the SqlServer and PSScriptAnalyzer modules. PowerShell trusts no repositories by default, so the installation policy must be set to Trusted before installing.

```yaml
jobs:
  install-dependencies:
    name: Install dependencies
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install from PSGallery
        shell: pwsh
        run: |
          Set-PSRepository PSGallery -InstallationPolicy Trusted
          Install-Module SqlServer, PSScriptAnalyzer
```

--------------------------------

### Example repository file structure for a local action

Source: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/find-and-customize-actions

Shows the directory layout when an action is defined in the same repository as the workflow. The action lives under .github/actions/hello-world-action with an action.yml file.

```shell
|-- hello-world (repository)
|   |__ .github
|       └── workflows
|           └── my-first-workflow.yml
|       └── actions
|           |__ hello-world-action
|               └── action.yml
```

--------------------------------

### Test multiple Go versions with a matrix using setup-go

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/go

Workflow that runs a build job across a matrix of Go versions ('1.19', '1.20', '1.21.x') using actions/setup-go@v5. The final step prints the current Go version with `go version` to verify the matrix.

```yaml
name: Go

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version: [ '1.19', '1.20', '1.21.x' ]

    steps:
      - uses: actions/checkout@v6
      - name: Setup Go ${{ matrix.go-version }}
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
      # You can test your matrix by printing the current Go version
      - name: Display Go version
        run: go version
```

--------------------------------

### Travis CI for building with Node.js

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-travis-ci

Travis CI installs dependencies in the install phase, then runs build and test in the script phase.

```yaml
install:
  - npm install
script:
  - npm run build
  - npm test
```

--------------------------------

### Example contents of the inputs context

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/contexts

Shows the JSON structure of the inputs context from a workflow that defined the build_id, deploy_target, and perform_deploy inputs.

```json
{
  "build_id": 123456768,
  "deploy_target": "deployment_sys_1a",
  "perform_deploy": true
}
```

--------------------------------

### Set up a specific Python version with setup-python using '3.x'

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/python

Configures actions/setup-python@v5 with the semantic version range '3.x' to get the latest minor release of Python 3. The architecture input is optional and defaults to x64.

```yaml
name: Python package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v6
      - name: Set up Python
        # This is the version of the action for setting up Python, not the Python version.
        uses: actions/setup-python@v5
        with:
          # Semantic version range syntax or exact version of a Python version
          python-version: '3.x'
          # Optional - x64 or x86 architecture, defaults to x64
          architecture: 'x64'
      # You can test your matrix by printing the current Python version
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
```

--------------------------------

### Install Actions Runner Controller Helm chart

Source: https://docs.github.com/en/actions/tutorials/use-actions-runner-controller/get-started

Installs the ARC operator and CRDs using Helm. Set NAMESPACE to the namespace where operator pods should be created; it must allow access to the Kubernetes API server. Pass --version to install a specific chart version.

```shell
NAMESPACE="arc-systems"
helm install arc \
    --namespace "${NAMESPACE}" \
    --create-namespace \
    oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set-controller
```

--------------------------------

### Example contents of the runner context (JSON)

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/contexts

Sample runner context object from a Linux GitHub-hosted runner, showing os, arch, name, tool_cache, and temp properties.

```json
{
  "os": "Linux",
  "arch": "X64",
  "name": "GitHub Actions 2",
  "tool_cache": "/opt/hostedtoolcache",
  "temp": "/home/runner/work/_temp"
}
```

--------------------------------

### Create Dockerfile for hello-world-docker-action

Source: https://docs.github.com/en/actions/tutorials/use-containerized-services/create-a-docker-container-action

Defines the container image for the action, copies entrypoint.sh into the container, and sets it as the ENTRYPOINT. The filename must be capitalized as Dockerfile (capital D, lowercase f).

```dockerfile
# Container image that runs your code
FROM alpine:3.10

# Copies your code file from your action repository to the filesystem path `/` of the container
COPY entrypoint.sh /entrypoint.sh

# Code file to execute when the docker container starts up (`entrypoint.sh`)
ENTRYPOINT ["/entrypoint.sh"]
```

--------------------------------

### Create a test workflow using the arc-runner-set runner scale set

Source: https://docs.github.com/en/actions/tutorials/use-actions-runner-controller/get-started

Add this workflow to a repository to test runner scale set runners. The runs-on value must match the Helm installation name used when installing the autoscaling runner set.

```yaml
name: Actions Runner Controller Demo
on:
  workflow_dispatch:

jobs:
  Explore-GitHub-Actions:
    # You need to use the INSTALLATION_NAME from the previous step
    runs-on: arc-runner-set
    steps:
    - run: echo "🎉 This job uses runner scale set runners!"
```

--------------------------------

### Check if Docker engine was installed using snap

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot

Use the which command to see the Docker binary path. A path like /snap/bin/docker indicates a snap installation, which may cause input passing issues.

```shell
$ which docker
/snap/bin/docker
```

--------------------------------

### Example configure command output for CircleCI

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/circleci-migration

Shows the interactive prompts and responses when configuring GitHub Actions Importer for CircleCI. The output confirms that environment variables were successfully updated.

```shell
$ gh actions-importer configure
✔ Which CI providers are you configuring?: CircleCI
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for CircleCI: ********************
✔ Base url of the CircleCI instance: https://circleci.com
✔ CircleCI organization name: mycircleciorganization
Environment variables successfully updated.
```

--------------------------------

### Example update command output

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/azure-devops-migration

Shows the expected output when the container image is already up-to-date. The output indicates the image is up-to-date.

```shell
Updating ghcr.io/actions-importer/cli:latest...
ghcr.io/actions-importer/cli:latest up-to-date
```

--------------------------------

### Example: Stopping and starting workflow commands (PowerShell)

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands

A GitHub Actions job that demonstrates stopping and resuming workflow commands using a GUID token. The first warning is processed, the second is not rendered because stop-commands is active, and the third is processed again after resuming.

```yaml
jobs:
  workflow-command-job:
    runs-on: windows-latest
    steps:
      - name: Disable workflow commands
        run: |
          Write-Output '::warning:: This is a warning message, to demonstrate that commands are being processed.'
          $stopMarker = New-Guid
          Write-Output "::stop-commands::$stopMarker"
          Write-Output '::warning:: This will NOT be rendered as a warning, because stop-commands has been invoked.'
          Write-Output "::$stopMarker::"
          Write-Output '::warning:: This is a warning again, because stop-commands has been turned off.'
```

--------------------------------

### Use a specific Go version with setup-go and semantic version syntax

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/go

Step that configures actions/setup-go@v5 with `go-version: '1.21.x'` to get the latest patch release of Go 1.21. Semantic version range syntax or an exact version can be used.

```yaml
      - name: Setup Go 1.21.x
        uses: actions/setup-go@v5
        with:
          # Semantic version range syntax or exact version of Go
          go-version: '1.21.x'
```

--------------------------------

### Install @actions/core and @actions/github toolkit packages

Source: https://docs.github.com/en/actions/tutorials/create-actions/create-a-javascript-action

Run this command in your terminal to install the actions toolkit core and github packages. It creates a node_modules directory and package-lock.json; do not commit node_modules to your repository.

```shell
npm install @actions/core @actions/github
```

--------------------------------

### Cache npm dependencies with setup-node

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/nodejs

Uses the setup-node action with cache: 'npm' to cache and restore npm dependencies. Runs npm install and npm test after checkout.

```yaml
steps:
- uses: actions/checkout@v6
- uses: actions/setup-node@v7
  with:
    node-version: '20'
    cache: 'npm'
- run: npm install
- run: npm test
```

--------------------------------

### Use setup-node with a matrix of Node.js versions

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/nodejs

Configures a matrix strategy that builds and tests with the Node.js versions listed in node-version, where 'x' matches the latest minor and patch release. Each version creates a job that uses the matrix context as the setup-node node-version input.

```yaml
strategy:
  matrix:
    node-version: ['18.x', '20.x']

steps:
- uses: actions/checkout@v6
- name: Use Node.js ${{ matrix.node-version }}
  uses: actions/setup-node@v7
  with:
    node-version: ${{ matrix.node-version }}
```

--------------------------------

### Install the gh-actions-lock GitHub CLI extension

Source: https://docs.github.com/en/actions/how-tos/secure-your-work/lock-workflow-dependencies

Run after installing the GitHub CLI to add the gh-actions-lock extension. To update it later, run `gh extension upgrade gh-actions-lock`.

```bash
gh extension install github/gh-actions-lock
```

--------------------------------

### Include matrix variables in actions/cache key for Ruby builds

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/ruby

In a matrix build, add matrix.os and matrix.ruby-version to the cache key so each combination gets its own cache. The bundle install step configures vendor/bundle and installs with jobs and retry options.

```yaml
steps:
- uses: actions/cache@v4
  with:
    path: vendor/bundle
    key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby-version }}-${{ hashFiles('**/Gemfile.lock') }}
    restore-keys: |
      bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby-version }}-
- name: Bundle install
  run: |
    bundle config path vendor/bundle
    bundle install --jobs 4 --retry 3
```

--------------------------------

### Example contents of the vars context

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/contexts

Shows the shape of the `vars` context: a mapping of configuration variable names to their values.

```json
{
  "mascot": "Mona"
}
```

--------------------------------

### Use multiple Swift versions in a matrix with swift-actions/setup-swift

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/swift

Configures a job matrix across ubuntu-latest and macos-latest with Swift 5.2 and 5.3, then builds and tests. The setup-swift action adds the selected Swift binaries to PATH for the rest of the job.

```yaml
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

# GitHub recommends pinning actions to a commit SHA.
# To get a newer version, you will need to update the SHA.
# You can also reference a tag or branch, but the action may change without warning.

name: Swift

on: [push]

jobs:
  build:
    name: Swift ${{ matrix.swift }} on ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest]
        swift: ["5.2", "5.3"]
    runs-on: ${{ matrix.os }}
    steps:
      - uses: swift-actions/setup-swift@65540b95f51493d65f5e59e97dcef9629ddf11bf
        with:
          swift-version: ${{ matrix.swift }}
      - uses: actions/checkout@v6
      - name: Build
        run: swift build
      - name: Run tests
        run: swift test

```

--------------------------------

### Watch runner pods being created with kubectl get pods

Source: https://docs.github.com/en/actions/tutorials/use-actions-runner-controller/get-started

Run this command from your terminal while the workflow is running to view the runner pods being created. A successful run shows the arc-runner-set pod in Running status.

```bash
kubectl get pods -n arc-runners -w
```

```bash
NAMESPACE     NAME                                                  READY   STATUS    RESTARTS      AGE
arc-runners   arc-runner-set-rmrgw-runner-p9p5n                     1/1     Running   0             21s
```

--------------------------------

### Run a shell command with the run keyword

Source: https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts

Use the `run` keyword in a job step to execute a command on the assigned runner. This example installs bats globally with `npm install -g bats` on ubuntu-latest.

```yaml
jobs:
  example-job:
    runs-on: ubuntu-latest
    steps:
      - run: npm install -g bats
```

--------------------------------

### Verify the GitHub Actions Importer extension is installed

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/use-github-actions-importer

Run the help command to confirm the extension is installed and list available commands such as update, configure, audit, forecast, dry-run, and migrate.

```bash
$ gh actions-importer -h
Options:
  -?, -h, --help  Show help and usage information

Commands:
  update     Update to the latest version of GitHub Actions Importer.
  version    Display the version of GitHub Actions Importer.
  configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
  audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
  forecast   Forecast GitHub Actions usage from historical pipeline utilization.
  dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
  migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.
```

--------------------------------

### Example output of a successful migrate command

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/gitlab-migration

Shows the output of a successful `migrate` run, including the log file path and the URL of the pull request that adds the converted workflow.

```shell
$ gh actions-importer migrate gitlab --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --namespace octo-org --project monas-project
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'
```

--------------------------------

### Configure workflow steps to check out code, install dependencies, and connect to Redis

Source: https://docs.github.com/en/actions/tutorials/use-containerized-services/create-redis-service-containers

Defines the job steps: checkout the repository, run npm ci, then run client.js. The Connect to Redis step sets REDIS_HOST to the service label `redis` and REDIS_PORT to 6379 so client.js can create the Redis client.

```yaml
steps:
  # Downloads a copy of the code in your repository before running CI tests
  - name: Check out repository code
    uses: actions/checkout@v6

  # Performs a clean installation of all dependencies in the `package.json` file
  # For more information, see https://docs.npmjs.com/cli/ci.html
  - name: Install dependencies
    run: npm ci

  - name: Connect to Redis
    # Runs a script that creates a Redis client, populates
    # the client with data, and retrieves data
    run: node client.js
    # Environment variable used by the `client.js` script to create a new Redis client.
    env:
      # The hostname used to communicate with the Redis service container
      REDIS_HOST: redis
      # The default Redis port
      REDIS_PORT: 6379
```

--------------------------------

### Check Helm installation with helm list -A

Source: https://docs.github.com/en/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets

Run this command to verify the runner scale set installation. The expected output lists the controller and runner scale set releases with their namespaces, status, chart, and app version.

```bash
helm list -A
```

```bash
NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                                       APP VERSION
arc             arc-systems     1               2023-04-12 11:45:59.152090536 +0000 UTC deployed        gha-runner-scale-set-controller-0.4.0       0.4.0
arc-runner-set  arc-systems     1               2023-04-12 11:46:13.451041354 +0000 UTC deployed        gha-runner-scale-set-0.4.0                  0.4.0
```

--------------------------------

### Configure workflow steps to check out, install dependencies, and connect to PostgreSQL

Source: https://docs.github.com/en/actions/tutorials/use-containerized-services/create-postgresql-service-containers

Defines the steps for a job running in a container: checkout the repository, run npm ci, then run client.js. The Connect to PostgreSQL step sets POSTGRES_HOST to the service label `postgres` and POSTGRES_PORT to 5432 so client.js can create the client.

```yaml
steps:
  # Downloads a copy of the code in your repository before running CI tests
  - name: Check out repository code
    uses: actions/checkout@v6

  # Performs a clean installation of all dependencies in the `package.json` file
  # For more information, see https://docs.npmjs.com/cli/ci.html
  - name: Install dependencies
    run: npm ci

  - name: Connect to PostgreSQL
    # Runs a script that creates a PostgreSQL table, populates
    # the table with data, and then retrieves the data.
    run: node client.js
    # Environment variable used by the `client.js` script to create
    # a new PostgreSQL client.
    env:
      # The hostname used to communicate with the PostgreSQL service container
      POSTGRES_HOST: postgres
      # The default PostgreSQL port
      POSTGRES_PORT: 5432
```

--------------------------------

### Use a single specific Swift version with swift-actions/setup-swift

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/swift

Sets up one specific Swift version, such as 5.3.3, via the swift-version input and verifies it with swift --version. Use this when a matrix of versions is not needed.

```yaml
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
steps:
  - uses: swift-actions/setup-swift@65540b95f51493d65f5e59e97dcef9629ddf11bf
    with:
      swift-version: "5.3.3"
  - name: Get swift version
    run: swift --version # Swift 5.3.3

```

--------------------------------

### Create Kubernetes secret for GitHub App authentication

Source: https://docs.github.com/en/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets

Create the secret in the same namespace where the gha-runner-scale-set chart is installed (arc-runners in this example). Then reference the secret name in values.yaml.

```bash
kubectl create secret generic pre-defined-secret \
  --namespace=arc-runners \
  --from-literal=github_app_id=123456 \
  --from-literal=github_app_installation_id=654321 \
  --from-file=github_app_private_key=private-key.pem
```

```yaml
githubConfigSecret: pre-defined-secret
```

--------------------------------

### Set up multiple Python versions with a matrix using setup-python

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/python

Uses a job matrix to run the workflow against multiple Python versions, including pypy3.10 and CPython 3.9 through 3.13. Each job sets up the matrix version with actions/setup-python@v5 and prints the interpreter version.

```yaml
name: Python package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["pypy3.10", "3.9", "3.10", "3.11", "3.12", "3.13"]

    steps:
      - uses: actions/checkout@v6
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
      # You can test your matrix by printing the current Python version
      - name: Display Python version
        run: python -c "import sys; print(sys.version)"
```

--------------------------------

### Check manager pod with kubectl get pods

Source: https://docs.github.com/en/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets

Run this command to check the manager pod. If the installation was successful, the pods show the Running status as in the expected output.

```bash
kubectl get pods -n arc-systems
```

```bash
NAME                                                   READY   STATUS    RESTARTS   AGE
arc-gha-runner-scale-set-controller-594cdc976f-m7cjs   1/1     Running   0          64s
arc-runner-set-754b578d-listener                       1/1     Running   0          12s
```

--------------------------------

### Run workflow when both branches and paths filters match

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows

When both branches and paths filters are used, the workflow runs only if both are satisfied. This example runs only for pushes to a branch starting with releases/ that include a change to a .js file.

```yaml
on:
  push:
    branches:
      - 'releases/**'
    paths:
      - '**.js'
```

--------------------------------

### Create Kubernetes secret for proxy credentials with kubectl

Source: https://docs.github.com/en/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets

Create a secret with your proxy credentials for authenticated proxies. Create it in the same namespace where the gha-runner-scale-set chart is installed (arc-runners in this example).

```bash
  kubectl create secret generic proxy-auth \
    --namespace=arc-runners \
    --from-literal=username=proxyUsername \
    --from-literal=password=proxyPassword \
```

--------------------------------

### Check recent runner activity with Get-EventLog

Source: https://docs.github.com/en/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot

Use PowerShell to view recent activity of the self-hosted runner from the Application log. The example output shows the application starting, receiving a job named `testAction`, and displaying the resulting status.

```powershell
PS C:\actions-runner> Get-EventLog -LogName Application -Source ActionsRunnerService

   Index Time          EntryType   Source                 InstanceID Message
   ----- ----          ---------   ------                 ---------- -------
     136 Mar 17 13:45  Information ActionsRunnerService          100 2020-03-17 13:45:48Z: Job Greeting completed with result: Succeeded
     135 Mar 17 13:45  Information ActionsRunnerService          100 2020-03-17 13:45:34Z: Running job: testAction
     134 Mar 17 13:41  Information ActionsRunnerService          100 2020-03-17 13:41:54Z: Listening for Jobs
     133 Mar 17 13:41  Information ActionsRunnerService          100 û Connected to GitHub
     132 Mar 17 13:41  Information ActionsRunnerService            0 Service started successfully.
     131 Mar 17 13:41  Information ActionsRunnerService          100 Starting Actions Runner listener
     130 Mar 17 13:41  Information ActionsRunnerService          100 Starting Actions Runner Service
     129 Mar 17 13:41  Information ActionsRunnerService          100 create event log trace source for actions-runner service
```

--------------------------------

### Resolved restore-keys after expression evaluation

Source: https://docs.github.com/en/actions/reference/workflows-and-actions/dependency-caching

Shows the restore-keys from the previous example after the runner evaluates the expressions. The npm-feature- key matches any key starting with that string, and the most recently created matching cache is used.

```yaml
restore-keys: |
  npm-feature-d5ea0750
  npm-feature-
  npm-
```

--------------------------------

### Example configure command output for Bitbucket

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/automated-migrations/bitbucket-pipelines-migration

Shows the prompts and responses when configuring Bitbucket, including the GitHub and Bitbucket tokens and base URLs. Ends with a confirmation that environment variables were successfully updated.

```shell
$ gh actions-importer configure
✔ Which CI providers are you configuring?: Bitbucket
Enter the following values (leave empty to omit):
✔ Personal access token for GitHub: ***************
✔ Base url of the GitHub instance: https://github.com
✔ Personal access token for Bitbucket: ********************
✔ Base url of the Bitbucket instance: https://bitbucket.example.com
Environment variables successfully updated.
```

--------------------------------

### Use multiple .NET versions with setup-dotnet matrix

Source: https://docs.github.com/en/actions/tutorials/build-and-test-code/net

Configures a job matrix to test against multiple .NET SDK versions using actions/setup-dotnet@v4. The matrix value is passed to dotnet-version, and dotnet --version prints the active version.

```yaml
name: dotnet package

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        dotnet-version: [ '3.1.x', '6.0.x' ]

    steps:
      - uses: actions/checkout@v6
      - name: Setup dotnet ${{ matrix.dotnet-version }}
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: ${{ matrix.dotnet-version }}
      # You can test your matrix by printing the current dotnet version
      - name: Display dotnet version
        run: dotnet --version
```

--------------------------------

### Install a runner scale set with Helm

Source: https://docs.github.com/en/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets

Run this command to configure and install a runner scale set using ARC's Helm chart. Set INSTALLATION_NAME (usable as runs-on), NAMESPACE for runner pods, GITHUB_CONFIG_URL for the target entity, and GITHUB_PAT; pass --version to install a specific chart version. The example uses a personal access token for brevity; GitHub App authentication is recommended for repository or organization runners, while enterprise runners require a personal access token (classic).

```bash
INSTALLATION_NAME="arc-runner-set"
NAMESPACE="arc-runners"
GITHUB_CONFIG_URL="https://github.com/<your_enterprise/org/repo>"
GITHUB_PAT="<PAT>"
helm install "${INSTALLATION_NAME}" \
    --namespace "${NAMESPACE}" \
    --create-namespace \
    --set githubConfigUrl="${GITHUB_CONFIG_URL}" \
    --set githubConfigSecret.github_token="${GITHUB_PAT}" \
    oci://ghcr.io/actions/actions-runner-controller-charts/gha-runner-scale-set
```

--------------------------------

### GitHub Actions action syntax with actions/setup-python@v5

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-azure-pipelines

GitHub Actions syntax for running an action with inputs as key/value pairs. Uses actions/setup-python@v5 with python-version and architecture inputs, followed by a run step.

```yaml
jobs:
  run_python:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/setup-python@v5
        with:
          python-version: '3.7'
          architecture: 'x64'
      - run: python script.py
```

--------------------------------

### Define a build matrix in GitHub Actions syntax

Source: https://docs.github.com/en/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-travis-ci

GitHub Actions matrix configuration using `strategy.matrix` to list Ruby versions. Equivalent to the Travis CI `matrix.include` example.

```yaml
jobs:
  build:
    strategy:
      matrix:
        ruby: ['2.5', '2.6.3']
```
Tokens:
Raw