From 051535a77bbcef24e2d953054b65bb3fd802b4cb Mon Sep 17 00:00:00 2001 From: Ethan Dennis Date: Wed, 7 Dec 2022 09:54:33 -0800 Subject: [PATCH] Apply suggestions from code review --- .github/workflows/ci.yml | 2 +- .github/workflows/issue_ops.yml | 2 +- Readme.md | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0172b2a..7f9c69c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -7,7 +7,7 @@ on: env: ruby_version: 2.7.1 - # When using Self-Hosted Runner configurations, ImageOs must be populated to match the OS of the runner + # ImageOs must be configured to match the OS of the runner when using self-hosted runners. # ImageOS: ubuntu22 jobs: diff --git a/.github/workflows/issue_ops.yml b/.github/workflows/issue_ops.yml index 1bd176d..de6b160 100644 --- a/.github/workflows/issue_ops.yml +++ b/.github/workflows/issue_ops.yml @@ -45,7 +45,7 @@ jobs: - uses: ruby/setup-ruby@v1 with: ruby-version: 2.7.1 - # When using Self-Hosted Runner configurations, ImageOs must be populated to match the OS of the runner + # ImageOs must be configured to match the OS of the runner when using self-hosted runners. # env: # ImageOS: ubuntu22 - name: Install dependencies diff --git a/Readme.md b/Readme.md index 18eff3c..af4fcdc 100644 --- a/Readme.md +++ b/Readme.md @@ -118,13 +118,13 @@ You can learn more about authoring custom transformers by completing the self-gu - Custom transformers for Jenkins pipelines [exercise](https://github.com/actions/importer-labs/blob/main/jenkins/5-custom-transformers.md) - Custom transformers for Travis CI pipelines [exercise](https://github.com/actions/importer-labs/blob/main/travis/5-custom-transformers.md) -## GitHub Enterprise Server and Self-Hosted Runner Support +## Configuring IssueOps with GitHub Enterprise Server and self-hosted runners -This template can be used with GitHub Enterprise Server deployments or with Self-Hosted runners with additional considerations. +This template can be configured to be used with GitHub Enterprise Server deployments and self-hosted runners by: -1. See `Using self-hosted runners` details for action [ruby/setup-ruby](https://github.com/ruby/setup-ruby) to verify supported runner OS types and configuration prerequisites. -2. Labels for `runs-on:` for [workflow files](.github/workflows/) must be updated to match an available label for Self-Hosted Runners -3. For GitHub Enterprise Server deployments, this repository should be published and [converted to a template repository](https://docs.github.com/en/enterprise-server/repositories/creating-and-managing-repositories/creating-a-template-repository). +1. Updating the [ruby/setup-ruby](https://github.com/ruby/setup-ruby) actions in [issue_ops.yml](./.github/workflows/issue_ops.yml) and [ci.yml](./.github/workflows/ci.yml) to ensure the action runs on the correct OS type. +2. Updating the `runs-on:` statements in [ruby/setup-ruby](https://github.com/ruby/setup-ruby) actions in [issue_ops.yml](./.github/workflows/issue_ops.yml) to dictate the appropriate label(s) for your self-hosted runner. +3. For GitHub Enterprise Server deployments, this repository should be published and [converted to a template repository](https://docs.github.com/en/enterprise-server/repositories/creating-and-managing-repositories/creating-a-template-repository) in your GHES deployment. ## Privacy statement