nick_invision.macos_github_actions_runner
macos-github-actions-runner
この役割は、MacOS/MacOSX上で組織またはリポジトリレベルでGitHub Actionsのセルフホステッドランナーをインストールします。クリーンインストールを行い、必要に応じて再インストール、サービスが動作していない場合の再インストール、またはアンインストールを実行します。ansible-github_actions_runnerに大きく触発されていますが、MacOSで動作するように修正されています。
要件
この役割は、MacOS 10.13(High Sierra)以降でのみ使用すべきです。
以下の環境変数が必要です:
PERSONAL_ACCESS_TOKEN
- リポジトリランナーを追加する場合はrepo
スコープ、組織ランナーを追加する場合はadmin:org
スコープのGitHub PAT
以下の変数が必要です:
github_account
- 大文字と小文字を区別するGitHubアカウント名。これはGitHubユーザー名またはGitHub組織名です。access_token
- これはオプションで、必須のPERSONAL_ACCESS_TOKEN
環境変数の代わりに使用できます。
役割の変数
デフォルト(defaults/main.yml
から):
# ランナーのユーザー - ローカルランナーサービスが動作しているユーザー
runner_user: "vagrant"
# ローカルランナーがインストールされるディレクトリ
runner_dir: ~/actions-runner
# GitHub Actionsランナーのバージョン
runner_version: "latest"
# サーバー上に見つかった場合、既存のランナーサービスを削除して再インストール
reinstall_runner: no
# センシティブなデータ(登録トークン)を含む可能性のあるAnsibleのログを表示しない
hide_sensitive_logs: yes
# GitHubのアドレス
github_url: "https://github.com"
# GitHub API
github_api_url: "https://api.github.com"
# 自分のGitHubアカウントのためのパーソナルアクセストークン
access_token: "{{ lookup('env', 'PERSONAL_ACCESS_TOKEN') }}"
# これは組織用のランナーですか?
runner_org: no
# GitHubにこのランナーに割り当てる名前(デフォルトはシステムホスト名)
runner_name: "{{ hostname }}"
# ランナーに適用するラベル
runner_labels: []
# ランナーの作業ディレクトリ
runner_work_dir: "_work"
# `config.sh`に渡す追加の引数
runner_extra_config_args: ""
依存関係
なし
例プレイブック
リポジトリレベルのGitHubセルフホステッドランナーを構成するには:
- name: GitHub Actionsランナーをインストール
hosts: macs
user: ansible
become: yes
vars:
- github_account: github-access-user
- github_repo: my_awesome_repo
roles:
- role: nick-invision.macos_github_actions_runner
組織レベルのGitHubセルフホステッドランナーを構成するには:
- name: GitHub Actionsランナーをインストール
hosts: macs
user: ansible
become: yes
vars:
- github_account: github-access-user
- runner_org: true
roles:
- role: nick-invision.macos_github_actions_runner
さまざまなオーバーライドを使用してGitHubセルフホステッドランナーを構成するには:
- name: GitHub Actionsランナーをインストール
hosts: macs
user: ansible
become: yes
vars:
- github_account: github-access-user
- runner_org: true
- runner_labels:
- some-label
- runner_version: 2.277.0
roles:
- role: nick-invision.macos_github_actions_runner
ライセンス
MIT