注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
はじめに
このチュートリアルでは、ワークフローで andymckay/labeler
アクションを使用して、新しくオープンまたは再オープンした Issue にラベルを付ける方法を示します。 たとえば、Issue をオープンまたは再オープンするたびに triage
ラベルを追� できます。 次に、triage
ラベルで Issue をフィルター処理して、トリアージする必要のあるすべての Issue を確認できます。
チュートリアルでは、andymckay/labeler
アクションを使用するワークフロー ファイルをまず作成します。 次に、ニーズに合わせてワークフローをカスタマイズします。
ワークフローの作成
-
このプロジェクト管理ワークフローを適用したいリポジトリを選択してく� さい。 書き込みアクセス権を持つ既存のリポジトリを利用することも、新しいリポジトリを作成することもできます。 リポジトリの作成の詳細については、「新しいリポジトリの作成」を参照してく� さい。
-
リポジトリに
.github/workflows/YOUR_WORKFLOW.yml
というファイルを作成します (YOUR_WORKFLOW
は任意の名前に置き換えます)。 これがワークフローファイルです。 GitHub での新しいファイルの作成の詳細については、「新しいファイルの作成」を参照してく� さい。 -
次の YAML コンテンツをワークフローファイルにコピーします。
YAML # このワークフローはGitHubによって認定されていないアクションを使用します。 # それらはサードパーティによって提供され、 # 別個の利用規約、プライバシーポリシー、 # ドキュメントを参照してく� さい。 # GitHub では、コミット SHA にアクションをピン留めすることが推奨されます。 # 新しいバージョンを取得するには、SHA を更新する必要があります。 # タグまたはブランチを参照することもできますが、アクションは警告なしに変更される可能性があります。 name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - name: Label issues uses: andymckay/labeler@e6c4322d0397f3240f0e7e30a33b5c5df2d39e90 with: add-labels: "triage" repo-token: ${{ secrets.GITHUB_TOKEN }}
-
ワークフローファイルのパラメータをカスタマイズします。
add-labels
の値を、Issue に追� するラベルのリストに変更します。 複数のラベルはコンマで区切ります。 たとえば、「"help wanted, good first issue"
」のように入力します。 ラベルの詳細については、「ラベルを管理する」を参照してく� さい。
-
ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてく� さい。 詳細については、「新しいファイルの作成」を参照してく� さい。
ワークフローのテスト
リポジトリ内の Issue をオープンするか再オープンするたびに、このワークフローは指定したラベルを Issue に追� します。
リポジトリに Issue を作成して、ワークフローをテストします。
- リポジトリで Issue を作成します。 詳細については、「Issue の作成」を参照してく� さい。
- Issue の作成によってトリガーされたワークフローの実行を確認するには、ワークフローの実行履歴を表示します。 詳細については、「ワークフロー実行の履歴を表示する」を参照してく� さい。
- ワークフローが完了すると、作成した Issue に指定されたラベルが追� されます。
次の手� �
- ラベルの削除や、Issue が割り当てられているか特定のラベルがある� �合にこのアクションをスキップするなど、
andymckay/labeler
アクションで実行できる追� の機能の詳細については、andymckay/labeler
アクションのドキュメントを参照してく� さい。 - ワークフローをトリガーできるさまざまなイベントの詳細については、「ワークフローをトリガーするイベント」を参照してく� さい。
andymckay/labeler
アクションは、issues
、pull_request
、project_card
のいずれかのイベントでのみ機能します。 - このアクションを使用するワークフローの例については GitHub を検索してく� さい。