PLEASE update this file if you add new GitHub Action or change name/trigger phrase of a GitHub Action.

About GitHub Actions Runners and Self-hosted Runners

According to GitHub Docs, we can define a GitHub-hosted runner and a self-hosted runner as the following:

  • A GitHub-hosted runner is a new virtual machine (VM) hosted by GitHub with the runner application and other tools preinstalled, and is available with Ubuntu Linux, Windows, or macOS operating systems.
  • A self-hosted runner is a system that you deploy and manage to execute jobs from GitHub Actions on GitHub.com.

Apache Beam GitHub Actions

Currently, we have both GitHub-hosted and self-hosted runners for running the GitHub Actions workflows, hosted on Google Cloud Platform(GCP) Virtual Machines and Google Kubernetes Engine(GKE). The majority of our workflows that run in Ubuntu and Windows run in self-hosted runners, except for those that runs on MacOS and the Monitor Self-Hosted Runners Status workflow that monitors our GCP self-hosted runners.

Getting Started with self-hosted runners

  • Refer to this README for the steps for creating your own self-hosted runners for testing your workflows.
  • Depending on your workflow's needs, it must specify the following runs-on tags to run in the specified operating system:
    • Ubuntu 24.04 self-hosted runner: [self-hosted, ubuntu-24.04, main] (also small, highmem, or highmem22 pool labels as needed)
    • Windows Server 2019 self-hosted runner: [self-hosted, windows-server-2019]
    • MacOS GitHub-hosted runner: macos-latest
  • Every workflow that tests the source code needs to have the workflow trigger pull_request.
  • The workflow must have set read permissions for all the available scopes and jobs: permissions: read-all. It must be set at the top of the jobs directive.
  • If your workflow runs successfully in a GitHub-hosted runner but not in the self-hosted runner, it might need a new installation step.
  - name: Setup Node
    uses: actions/setup-node@v7
    with:
      node-version: 24

GitHub Actions Example

name: GitHub Actions Example
on:
  pull_request:
    branches: ['master']
permissions: read-all
jobs:
  github-actions-example:
    runs-on: [self-hosted, ubuntu-24.04, main]
    steps:
      - name: Check out repository code
        uses: actions/checkout@v2
      - run: echo "This job is now running on a ubuntu server hosted by Apache Beam!"
      - name: Setup Node
          uses: actions/setup-node@v7
          with:
            node-version: 24
          - name: Install npm dependencies
            run: npm ci
            working-directory: 'scripts/ci/your-path'
          - name: Run Node.js code
            run: npm run functionName
            env:
              VAR_1: my-var
            working-directory: 'scripts/ci/your-path'

IMPORTANT for Committers

  • A detailed review for changes in the workflows is needed due to important security concerns.
  • DO NOT Approve and Run changes in the workflows in the PR Conversation tab, under “Workflow(s) awaiting approval”.
  • For approving the updates in the workflows, you should go to the Repository Actions and filter All Workflows by action_required. The search will display the workflows that need to be reviewed before running. Please make sure reviewing the file that is referenced by the workflow.

Issue Management

Phrases self-assign, close, or manage labels on an issue:

PhraseEffect
.take-issueSelf-assign the issue
.free-issueSelf-unassign the issue
.close-issueClose the issue as completed
.close-issue not_plannedClose the issue as not-planned
.reopen-issueReopen a closed issue
.add-labelsAdd comma separated labels to the issue (e.g. add-labels l1, 'l2 with spaces')
.remove-labelsRemove comma separated labels to the issue (e.g. remove-labels l1, 'l2 with spaces')
.set-labelsSets comma separated labels to the issue and removes any other labels (e.g. set-labels l1, 'l2 with spaces')

Security Model

For information on the Beam CI security model, see https://cwiki.apache.org/confluence/display/BEAM/CI+Security+Model