1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md
Edward Thomson 9c1f6688e7 actions: self-hosted runner address information (#22628)
* actions: public repositories are only dotcom and ghec

Remove the disclaimer about public repositories for ghes/ghae.

* actions: don't show customizing page to ghes

GitHub-hosted runners are not supported on GHES (yet).  Don't show them
the page on how to customize them.

* actions: clarify host requirements for accessing GitHub from self-hosted

* actions: correct and expand GHAE domains necessary for self-hosted

* actions: GHES self-runners talk to dotcom in GitHub Connect

* actions: minimize GitHub-hosted page for GHES

There's no GitHub-hosted runners for GHES, minimize the amount of talk
that we do about them.

* actions: self-hosted runners update from a new endpoint

We're changing the way release content is stored, it's moving to
`objects.github.com`.

* Apply suggestions from code review

Thanks!

Co-authored-by: Martin Lopes <martin389@github.com>

* actions: correct self-hosted runner hostname

Self-hosted runners talk to objects.githubusercontent.com, not
objects.github.com.

Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2021-11-10 22:25:20 +00:00

2.5 KiB

title, intro, versions, type, topics, shortTitle
title intro versions type topics shortTitle
Customizing GitHub-hosted runners You can install additional software on GitHub-hosted runners as a part of your workflow.
fpt ghec
* *
tutorial
Workflows
Customize runners

{% data reusables.actions.ae-hosted-runners-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %}

If you require additional software packages on {% data variables.product.prodname_dotcom %}-hosted runners, you can create a job that installs the packages as part of your workflow.

To see which packages are already installed by default, see "Preinstalled software."

This guide demonstrates how to create a job that installs additional software on a {% data variables.product.prodname_dotcom %}-hosted runner.

Installing software on Ubuntu runners

The following example demonstrates how to install an apt package as part of a job.

{% raw %}

name: Build on Ubuntu
on: push

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository code
        uses: actions/checkout@v2
      - name: Install jq tool
        run: |
          sudo apt-get update
          sudo apt-get install jq

{% endraw %}

{% note %}

Note: Always run sudo apt-get update before installing a package. In case the apt index is stale, this command fetches and re-indexes any available packages, which helps prevent package installation failures.

{% endnote %}

Installing software on macOS runners

The following example demonstrates how to install Brew packages and casks as part of a job.

{% raw %}

name: Build on macOS
on: push

jobs:
  build:
    runs-on: macos-latest
    steps:
      - name: Check out repository code
        uses: actions/checkout@v2
      - name: Install GitHub CLI
        run: |
          brew update
          brew install gh
      - name: Install Microsoft Edge
        run: |
          brew update
          brew install --cask microsoft-edge

{% endraw %}

Installing software on Windows runners

The following example demonstrates how to use Chocolatey to install the {% data variables.product.prodname_dotcom %} CLI as part of a job.

{% raw %}

name: Build on Windows
on: push
jobs:
  build:
    runs-on: windows-latest
    steps:
      - run: choco install gh
      - run: gh version

{% endraw %}