概要
最近GitHub Actions Certificationを受験しようとしており、その対策として以下のUdemyの対策問題集に取り組んでいます
[NEW] GitHub Actions Certification - Practice Exam 2024 | Udemy
しかし、いかんせん全て英語のため英語が苦手な自分にとっては非常に苦痛であります
特に英単語は１つの単語に様々な意味が含まれているため、しっくりくる日本語訳を調べるのに苦慮しており、調べて良い感じの日本語を見つけられたとしても時間が経つと当然忘れ、また調べては忘れ、、、を繰り返しなかなかに不毛な時間を過ごしてしまってました
加えて、例えばGITHUB_OUTPUTなど自分が知らないGitHub Actions特有のものも多く、その用語が出てきたときにいちいちリファレンスや参考記事を調べるのも面倒でした
なのでこの記事では
- IT関連用語・非関連用語(例えば
representみたいな一般的な英単語)を、自分なりにしっくりきた日本語訳にしてまとめる - GitHub ActionsやGitHub特有の専門的な用語や使用される環境変数・プロパティ等の簡単な用途と、それに対する自分がしっくりきた記事や公式リファレンスを載せておく
以上2点を[NEW] GitHub Actions Certification - Practice Exam 2024 | Udemyで出てきた用語に準じて載せていきます
※上記Udemyの講座に出てきた内容のみとなっているため、当然網羅性があるわけではないのでご承知おきください
※訳や意味はあくまで自分がしっくりきたものを載せています ただ、内容にご指摘があれば是非お願いいたします
GitHub ActionsやGitHub固有の用語
| 英語 | 日本語・用途 | リファレンス(あれば) |
|---|---|---|
branch_protection_rule(on.branch_protection_rule) |
ブランチ保護ルール 指定したブランチを安全に保護するため、例えばマージ条件など様々なルールを適用できる |
ブランチ保護ルールを管理する - GitHub Docs / ワークフローをトリガーするイベント - GitHub Docs |
| Artifacts | 成果物 ジョブ間で成果物(ファイルやコンテナ等)の受け渡しや保存ができる ダウンロードもread権限で可能 |
ワークフローからのデータの格納と共有 - GitHub Docs |
| dependent jobs | 依存ジョブ 同一ワークフロー内の複数ジョブは何も指定しなければ並列実行されるが、 needsを指定することで依存関係を作り直列実行することも可 |
About workflows/creating-dependent-job - GitHub Docs |
| Set up job Complete job |
ワークフロー実行ログにGitHubが自動追加するステップ ランナーイメージや GITHUB_TOKENの情報等が記録されている |
ワークフロー実行ログの使用 - GitHub Docs |
| workflow badges | ワークフローのステータスバッジ README.mdなどのファイルにワークフローがパスしてるか失敗してるかといったステータスを表示することができるバッチ |
ワークフロー状態バッジの追加 - GitHub Docs |
| ephemeral runners | エフェメラルランナー ランナーがジョブ開始時に起動し、終了されると破棄される特性をエメフェラルと呼ぶ その特性を持ったランナーのこと |
自動スケーリングにエフェメラル ランナーを使用する - GitHub Docs |
| self-hosted runners | セルフホステッドランナー ユーザ側で用意するジョブ実行環境 GitHuｂが用意するのはGitHub-hosted runners |
セルフホステッド ランナーの概要 - GitHub Docs |
| Github Enterprise Cloud | エンタープライズクラウド 最上位有料プランの機能 GitHubがコードをホスティングしてくれる |
About GitHub Enterprise Cloud - GitHub Enterprise Cloud Docs |
| upload-artifact | ジョブで生成したファイル等をアップロードや保存するアクション | ・ビルドおよびテストの成果物をアップロードする - GitHub Docs ・actions/upload-artifact |
| runner group | ランナーグループ Organization単位でランナーへのアクセスを制御し、セキュリティ境界を作ることができる |
・ランナー グループについて - GitHub Docs ・GitHub Actions で 大規模ランナー（GitHub-hosted larger runners）が GA となりました DevelopersIO |
| IP address allowlist | IPアドレス許可リスト organizationsのリソースにアクセスできるIPを指定 |
組織に対する許可 IP アドレスを管理する - GitHub Enterprise Cloud Docs |
| GitHub Packages | GitHubが提供するパッケージを配置するツール | Packages GitHub |
| workflow logs | ワークフロー実行時に流れるログ REST APIを使用してダウンロードする場合、 repo・owner・run_idが必須 |
Download workflow run logs - GitHub Docs |
| actions/toolkit | アクションを簡単に作成するためのjavascript製パッケージ一式 | ・ワークフローコマンドを使ったツールキット関数へのアクセス - GitHub Docs ・actions/toolkit: The GitHub ToolKit for developing GitHub Actions. |
| Sharing actions and workflows from your private repository | プライベートリポジトリからのアクションとワークフローの共有 | Sharing actions and workflows from your private repository - GitHub Docs |
$GITHUB_PATH |
この環境変数にパスを出力することでステップをまたいでパスを有効にできる | ・GitHub Actions のワークフロー コマンド - GitHub Docs ・【GitHub Actions】シェルスクリプトでSTEPをまたいでPATHを通す(GITHUB_PATH) - suer TIL |
ACTIONS_STEP_DEBUG |
ステップデバッグログを設定するための変数 SecretsかVariablesにこの変数の値を trueで登録することでステップのデバッグログを有効化できる |
デバッグ ログを有効にする - GitHub Docs |
ACTIONS_RUNNER_DEBUG |
ランナーデバッグログを設定するための変数 SecretsかVariablesにこの変数の値を trueで登録することでランナーのデバッグログを有効化できる |
デバッグ ログを有効にする - GitHub Docs |
timeout-minutes |
タイムアウトする時間を指定するキー ジョブレベルかステップレベルで指定可能 ちなデフォルトタイムアウト時間は360分 |
ギットハブ アクション のワークフロー構文 - GitHub Docs |
on.create |
ブランチかタグが作成された時にワークフローを実行するキー | ワークフローをトリガーするイベント - GitHub Docs |
| workflow templates | ワークフローテンプレート Organization内の人が簡単に新しいワークフローを作成できるテンプレート |
組織のワークフロー テンプレートを作成する - GitHub Docs |
restore-keys |
actions/cacheアクションで使用できるオプション keyキーで一致するキャッスが無い場合(キャッシュミス)に部分一致のキャッシュを取得 |
依存関係をキャッシュしてワークフローのスピードを上げる - GitHub Docs |
on.check_run |
Checks APIの実行結果でトリガーするイベント？（よくわかっていない） |
ワークフローをトリガーするイベント - GitHub Docs |
| GITHUB_* RUNNER_* |
GITHUB_* および RUNNER_* という名前の既定の環境変数の値を上書きすることはできない | 環境変数の設定 - GitHub Docs |
RUNNER_OS |
実行ジョブのランナーOSを取得する環境変数 | 既定の環境変数 - GitHub Docs |
RUNNER_ARCH |
実行ジョブのランナーのアーキテクチャを取得する環境変数 | 既定の環境変数 - GitHub Docs |
RUNNER_DEBUG |
追加のデバッグまたは詳細ログを有効にするためのインジケーター用の変数 デバッグログが有効になってる場合に 1が出力される |
既定の環境変数 - GitHub Docs |
| Set up job | GithubHostedランナーで実行される場合のデフォルトステップ ランナーイメージ詳細、OSやGITHUB_TOKENのpermission情報等がセットアップされる |
ワークフロー実行ログの使用 - GitHub Docs |
| environment's protection rule | リポジトリごとに構築したEnvironmentに対して、デプロイメントの保護規則やsecret等のルールの総称を指す 全てのルールをパスしないとワークフローは動かない |
About environments - GitHub Docs |
GITHUB_TOKEN |
Github Actionsが自動生成→自動破棄まで行うジョブを認証するためのクレデンシャルを保持する環境変数 $ {{ secrets.GITHUB_TOKEN }} や $ {{ github.token }}といった形式で参照する |
自動トークン認証 - GitHub Docs |
on.schedule |
scheduleイベント ワークフローの定期実行設定（UTCなので注意） | ワークフローをトリガーするイベント - GitHub Docs |
on.pull_requeston.pull_request_target
|
プルリクエストをトリガーにするイベント targetのほうがセキュアだがかなり仕様が複雑らしい |
ギットハブ アクション のワークフロー構文 - GitHub Docs |
continue-on-error |
ステップのエラーを握り潰すキー 正常終了扱いになる |
ギットハブ アクション のワークフロー構文 - GitHub Docs |
github.event |
イベントを取得するプロパティ | ワークフローをトリガーするイベント - GitHub Docs |
| IP address ranges | GitHub REST APIを使ってGitHub-hosted-runnerに使われるIPアドレス範囲のリストを取得できる | GitHub ホステッド ランナーの概要 - GitHub Docs |
strategy.matrix |
マトリクス 1つのジョブ定義で複数ジョブを実行できる |
Running variations of jobs in a workflow - GitHub Docs |
github.job |
実行中ジョブのジョブIDを取得するプロパティ | Accessing contextual information about workflow runs - GitHub Docs |
jobs.<job_id>.result |
ジョブの実行結果を取得するプロパティ reusanle workflowsで使用可能 |
Accessing contextual information about workflow runs - GitHub Docs |
| organization-level secret | 組織(organaization)で共有できるシークレット | GitHub Actions でのシークレットの使用 - GitHub Docs |
::workflow-command |
ワークフローコマンド 例えば echoで出力できる警告メッセージ等を取得stepとrunnerのやり取りのために使用される |
GitHub Actions のワークフロー コマンド - GitHub Docs |
on.<event_name>.types |
トリガーされたイベントのタイプを指定 | ギットハブ アクション のワークフロー構文 - GitHub Docs |
run-name |
ワークフローから生成されたワークフロー実行の名前 | ギットハブ アクション のワークフロー構文 - GitHub Docs |
GITHUB_REPOSITORY |
owner/repositoryの形式を取得できる環境変数 |
Store information in variables - GitHub Docs |
| Choose a workflow |
Actions→New workflowにある新しくワークフロー設定できるページ |
ワークフロー テンプレートの使用 - GitHub Docs |
| custom labels | 自分で作成したカスタムラベルをセルフホステッドランナーに割り当て、特定のジョブにルーティングさせることができる | ワークフローでのセルフホストランナーの利用 - GitHub Docs |
| Checks API | Checks APIを使用してワークフローのステータス、結果、ログを出力できる | ワークフロー実行ログの使用 - GitHub Docs |
https_proxy |
セルフホスト・ランナーがプロキシ・サーバーを介して通信するようにしたい場合にプロキシ設定ができる環境変数 | セルフホストランナーとプロキシ サーバーを使う - GitHub Docs |
一般的なIT語句
- なるべくGitHub Actionsに沿った例文をつけています
- 例文は良いものがあれば都度追加していきます
| 英語 | 日本語訳や意味 | 例文 | 例文訳 |
|---|---|---|---|
| network utilization | ネットワーク使用状況 | ||
| sequential execution order | 逐次実行 | ||
| naming convention | 命名規則 | ||
| filesystem | ファイルシステム 人間に分かりやすいファイル単位でデータの読み書きができるシステム |
We strongly recommend that actions use variables to access the filesystem rather than using hardcoded file paths | GitHub Actionsではファイルシステムにアクセスする場合、ハードコーディングされたファイルパスではなく変数の使用が強く推奨されている 既定の環境変数 - GitHub Docs |
| superset of JSON | JSONのスーパーセット(上位互換) | YAML is a strict superset of JSON | YAMLはJSONの厳密なスーパーセットである |
| external embedding | 外部埋め込み | Workflow badges in a private repository are not accessible externally to prevent embedding or linking from unauthorized sources | プライベートリポジトリのワークフローバッジは認証していないソースからの外部埋め込みやリンクを防ぐためにアクセスすることはできない |
| security measures | セキュリティ対策 | ||
| resource-intensive | リソース大量消費 | By using GitHub-hosted runners for common tasks and self-hosted runners for resource-intensive ones, you can balance cost-effectiveness and performance | Githubホステッドランナーを一般的なタスクに使用し、リソースを大量消費するタスクをセルフホステッドランナーに使用することで、費用対効果やパフォーマンスのバランスを保つことができる |
| reliability | 信頼性 | implement commit SHAs for versioning to ensure reliability and security | 信頼性とセキュリティを確保するために、コミットSHAを実装する |
| consistency | 一貫性 | ||
| compatibility | 互換性 | ||
| annotation | 注釈・タグ等を付ける工程 | By using workflow commands, you can create error annotations without directly modifying the workflow code | ワークフローコマンドを使用することで、ワークフローのコードを修正することなくエラー注釈を付けることができる |
| cache miss | キャッシュミス(キャッシュが存在せず読み込めない状態) | If there is a cache miss and the job completes successfully, the cache action automatically creates a new cache with the specified key and contents | キャッシュミスがあるがジョブは成功した場合、GitHub Actionsは自動的に新しいキャッシュを指定されたキーと内容で作成する |
| maintainability | 保守性 | ||
| case-sensitive | 大文字・小文字の区別 | Treating environment variables as case-sensitive is good practice to avoid issues and maintain consistency in the workflow | 変数の大文字小文字の区別をするのはワークフローの一貫性を保つためのベストプラクティス GitHub Docs |
| cost-effective | 費用対効果 | In scenarios where cost-effectiveness and minimal management are priorities, GitHub-hosted runners provided by GitHub are the most suitable option for GitHub Actions | 費用対効果と最小限管理が優先の場合、GitHub-hostedランナーはGitHub Actionsにおいて最も適切な選択肢である |
| parallel | 並列 | the steps to be executed in parallel or sequentially | 並列か直列で実行されるステップ |
| workload | コンピューティングやシステムなどにかかる処理 | Your organization primarily runs its workloads on the Windows operating system | あなたのオーガナイゼーションはwindowsOS上で処理を行っている |
| programmatically | プログラム的な | Here is a sample curl request to programmatically access logs | こちらがプログラムアクセスログを取得するサンプルのcurlリクエストです |
| vulnerability | 脆弱性 | ||
| comprehensive documentation | 包括的なドキュメント(きちんと内容が網羅的な形式の定まったドキュメントみたいな解釈を記事筆者はしている) | ||
| newlines | 改行 | YAML allows significant newlines and indentation, similar to Python, but unlike Python, it prohibits the use of literal tab characters for indentation | YAMLはPythonと似て大幅な改行とインデントを許容するが、Pythonはインデントのためにベタ書きのタブ文字は禁止している |
| semantic versioning (SemVer) | ソフトウェアのバージョンをどう管理するかについての決めごと | ||
| GPG | GNU Privacy Guard (GnuPG, GPG)の略で暗号化ソフトウェア 48KBより大きなシークレットを格納する場合に使用する 大きなシークレットを格納する - GitHub Docs |
||
| manually run | 手動実行 | What is required to manually run a private repository’s workflow using the GitHub REST API? | GitHub REST API を使ってプライベートリポジトリのワークフローを手動で実行するには何が必要ですか？→ Personal Access Token |
一般的な英単語
- なるべくGitHub Actionsに沿った例文をつけています
- 例文は良いものがあれば都度追加していきます
| 英語 | 日本語訳や意味 | 例文 | 例文訳 |
|---|---|---|---|
| conditionally | 条件付きで | Which keyword is used to conditionally execute a step based on a specific expression or condition?→if
|
どのキーワードが特定の式や条件に基づいて条件付きでステップを実行するのに使用されますか？→ if
|
| on behalf of | ~に代わって | ||
| configuration | 構成 | use the matrix keyword within the strategy configuration of the job | ジョブ構成でstrategyの中にmatrixキーワードを使う |
| narrow down | 絞り込む | ||
| consider | 考慮する | ||
| align | 整列させる・一直線に並べる | ||
| simplify | （難しいことを）簡単にする | ||
| implement | （プログラムに機能を）実装する | ||
| compatibility | 互換性 | ||
| overall | 全体の | ||
| represent | 表す | ||
| implement | 実施する | ||
| disruptions | |||
| address | 対処する | ||
| granularity | 粒度、細かさ | GitHub allows you to run scheduled workflows once every five minutes. It is the shortest interval that is allowed, meaning that the minimum time granularity available would be minutes. | GitHubではスケジュールされたワークフローを5分ごとに実行することができる。これは許可されている最短の間隔であり、利用可能な最小の時間粒度は分単位であることを意味する |
| retention period | 保存期間 | custom retention periods can be defined for individual artifacts using the actions/upload-artifact action |
actions/upload-artifactアクションを使用して、個々の成果物にカスタム保存期間を定義できる |
| chargeback | 支払い取り消し | ||
| segregate | 分離する | ||
| subsequent | 次の・後続の | The outputs key in the action's metadata syntax is used to declare the outputs produced by the action. These outputs can then be consumed by subsequent steps in the workflow | アクションのメタデータ構文のoutputsキーは、アクションによって生成されるアウトプットを宣言するために使用される。これらの出力は、ワークフロー内の後続ステップで使用される |
| insists on | 主張する | ||
| appropriate | 適切な | ||
| facilitate | 容易にする | ||
| are concerned about | 懸念する | ||
| be looking to | ~しようと思っている | ||
| in charge of | ~を担当する | ||
| auditing | 監査 | ||
| conduct | ~を行う(レビューを行うとか) | ||
| alleviate | ~を和らげる | ||
| redact | ~を編集する | GitHub automatically redacts secrets printed to workflow logs, replacing them with placeholders | Githubは自動でワークフローに出ているsecretをプレースホルダーに置き換えるように編集する |
| accurately | 正確に | ||
| distribute | 〜を割り当てる/〜を配布する | prepare to distribute your custom GitHub Action | カスタムアクションを配布する準備をする |
| urgent issues | 緊急の問題 | ||
| interprets | 〜を解釈する | GitHub Actions interprets a zero exit code as success | GitHubActionsはexitコードが0を成功とみなす |
| optimal | 最適な 最善の | ||
| dedicated | 専用の | dedicated repository | 専用リポジトリ |
| cumbersome | 煩雑な・面倒な | ||
| initiate | 〜を開始する | initiate the workflow | ワークフローを開始する |
| decision-making process | 意思決定プロセス | ||
| verbosity | 冗長性 | increase the verbosity of the job's logs | ジョブのログの冗長性を高める |
| retrieve | 〜を取得する | retrieve the expiration date | 有効期限を取得する |
| grant | 〜を付与する | grant repository access permissions at the group level | グループレベルでリポジトリアクセス権を付与する |
| eligible | 資格がある | runner must have all assigned labels to be eligible | ランナーは（実行する）資格をもったラベルを持たねばならない |
| do what it says it does | （想定通り）機能する | make sure the code does what it says it does | コードが想定通り機能しているか確かめる |
| be looking to | ~するつもりである | ||
| cumulatively | 累積的な | Custom labels in GitHub Actions operate cumulatively, meaning a self-hosted runner must have all assigned labels to be eligible to process a job | GitHub Actionsのカスタムラベルは累積的に動作する、つまりセルフホステッドランナーがジョブを処理するには、割り当てられたラベルをすべて持っている必要がある |
| typical | 典型的な | typical scenario | 典型的なシナリオ |
| sequence | 連続の | A job is a unit of work that can contain a sequence of steps | ジョブは連続したステップを含むことができる一連の作業である |
| foster | ~を促進する | you want to foster collaboration and contribution from the broader GitHub community to enhance the features and functionality over time | GitHub コミュニティの協力や貢献を促進し、機能や特徴を時間とともに向上させたい |
| dedicated | 専有の | self-hosted runner with dedicated hardware | 専有ハードウェアによるセルフホストランナー |
| drawback | 欠点 | What is a drawback of using tags for versioning GitHub Actions | Github Actionsでタグを使用することの欠点は何 |
| be prone to | ~の傾向がある | Tags may not accurately represent the commit history and can be prone to deletion or movement. The recommended alternative is to use commit SHAs for versioning | タグは正確にコミット履歴を表すとは限らず、削除されたり移動する傾向がある commit SHAsを使おう |
| concise | 簡潔な | ||
| consideration | 考慮事項 | Considerations should be made when developing JavaScript actions for GitHub Actions to ensure compatibility with all GitHub-hosted runners is writing the JavaScript code to be pure JavaScript | Javascript Actionを開発するときにGitHub-hosted runnersとの互換性を確保するために考慮すべきことは、バニラJSで書くこと |
| terms of service | 利用規約 | you must accept the terms of service to publish actions in GitHub Marketplace | GitHub Marketplaceに公開するために利用規約に同意しなければならない |
| collaborate | 協働する | You are collaborating with a colleague using their repository in GitHub | 友人とGitHubリポジトリで協働している |
| capability | 機能・能力 | What capability does GitHub provide to enable runners to download actions from internal or private repositories, ensuring access control and security? →scoped installation token with read access to the repository, automatically expiring after one hour |
ランナーが社内やプライベートリポジトリからアクションをダウンロードし、アクセスコントロールやセキュリティを確保するためにGithubが提供している機能は？ → 1時間で自動失効となるリードアクセスができるインストレーショントークン |
| organization-wide | 組織全体の | implement and enforce an organization-wide naming convention that clearly identifies the component type, purpose, and version | コンポーネントタイプや目的やバージョンを明確にする組織全体の命名規則を導入し実施しよう |
| be compatible with | 〜と互換性がある | GitHub Packages is compatible with the following package managers | GitHub Packagesは.NET,JavaScript ,Ruby, Java(mvn), Java(gradle),Docker containerと互換性がある |
| error-prone | エラーを起こしやすい | having to update the allowlist for GitHub-hosted runner IP addresses on a weekly basis could be time-consuming and error-prone | 週単位でGithubホステッドランナーのためのIPアドレス許可リストをアップデートしなければならないことは時間浪費やエラーを起こしやすくさせる |