PLEASE update this file if you add new GitHub Action or change name/trigger phrase of a GitHub Action.
According to GitHub Docs, we can define a GitHub-hosted runner and a self-hosted runner as the following:
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.
runs-on
tags to run in the specified operating system:[self-hosted, ubuntu-20.04]
[self-hosted, windows-server-2019]
macos-latest
pull_request_target
instead of pull_request
.permissions: read-all
. It must be set at the top of the jobs
directive.pull_request_target
trigger, in the checkout step must be added a ref to ${{ github.event.pull_request.head.sha }}
- name: Checkout code uses: actions/checkout@v# with: ref: ${{ github.event.pull_request.head.sha }}
- name: Setup Node uses: actions/setup-node@v3 with: node-version: 16
name: GitHub Actions Example on: pull_request_target: branches: ['master'] permissions: read-all jobs: github-actions-example: runs-on: [self-hosted, ubuntu-20.04] steps: - name: Check out repository code uses: actions/checkout@v2 with: ref: ${{ github.event.pull_request.head.sha }} - run: echo "This job is now running on a ubuntu server hosted by Apache Beam!" - name: Setup Node uses: actions/setup-node@v3 with: node-version: 16 - 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'
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.Approve and Run
built-in feature of GitHub Actions, since the workflows will use the pull_request_target
directive; no modifications would be allowed either for new or existent jobs unless a committer explicitly approves the job from GitHub Actions UI.Phrases self-assign, close, or manage labels on an issue: | Phrase | Effect | |--------|--------| | .take-issue
| Self-assign the issue | | .close-issue
| Close the issue as completed | | .close-issue not_planned
| Close the issue as not-planned | | .reopen-issue
| Reopen a closed issue | | .add-labels
| Add comma separated labels to the issue (e.g. add-labels l1, 'l2 with spaces'
) | | .remove-labels
| Remove comma separated labels to the issue (e.g. remove-labels l1, 'l2 with spaces'
) | | .set-labels
| Sets comma separated labels to the issue and removes any other labels (e.g. set-labels l1, 'l2 with spaces'
) |