Issue にラベルを追加する

GitHub Actions を使用して、Issue に自動的にラベルを付けることができます。

GitHub ActionsはGitHub Free、GitHub Pro、GitHub FreeのOrganization、GitHub Team、GitHub Enterprise Cloud、GitHub AEで利用できます。 GitHub Actionsは、レガシーのリポジトリごとのプランを使っているアカウントが所有しているプライベートリポジトリでは利用できません。 詳しい情報については「GitHubの製品」を参照してください。

はじめに

このチュートリアルでは、ワークフローで andymckay/labeler アクションを使用して、新たにオープンされた Issue または再オープンされた Issue にラベルを付ける方法を説明します。 たとえば、Issue をオープンまたは再オープンするたびに triage ラベルを追加できます。 次に、triage ラベルの Issue をフィルタすることで、トリアージする必要のあるすべての Issue を確認できます。

チュートリアルでは、最初に andymckay/labeler アクションを使用するワークフローファイルを作成します。 次に、ニーズに合わせてワークフローをカスタマイズします。

ワークフローの作成

  1. このプロジェクト管理ワークフローを適用したいリポジトリを選択してください。 書き込みアクセス権を持つ既存のリポジトリを利用することも、新しいリポジトリを作成することもできます。 リポジトリの作成に関する詳細は「新しいリポジトリの作成」を参照してください。

  2. リポジトリに、.github/workflows/YOUR_WORKFLOW.ymlというファイルをYOUR_WORKFLOWの部分を選択した名前で置き換えて作成してください。 これがワークフローファイルです。 GitHub上での新しいファイルの作成に関する詳しい情報については「新しいファイルの作成」を参照してください。

  3. 次の YAML コンテンツをワークフローファイルにコピーします。

    YAML
    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@1.0.2
            with:
              add-labels: "triage"
              repo-token: ${{ secrets.GITHUB_TOKEN }}
  4. ワークフローファイルのパラメータをカスタマイズします。

    • add-labels の値を、Issue に追加するラベルのリストに変更します。 複数のラベルはコンマで区切ります。 たとえば、"help wanted, good first issue" というようにします。 ラベルの詳細については、「ラベルを管理する 」を参照してください。
  5. ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてください。 詳細は「新しいファイルを作成する」を参照してください。

ワークフローのテスト

リポジトリ内の Issue をオープンするか再オープンするたびに、このワークフローは指定したラベルを Issue に追加します。

リポジトリに Issue を作成して、ワークフローをテストします。

  1. リポジトリで Issue を作成します。 詳しい情報については、「>Issue を作成する」を参照してください。
  2. Issue の作成によってトリガーされたワークフローの実行を確認するには、ワークフローの実行履歴を表示します。 詳しい情報については、「ワークフロー実行の履歴を表示する」を参照してください。
  3. ワークフローが完了すると、作成した Issue に指定されたラベルが追加されます。

次のステップ

  • ラベルの削除や、Issue が割り当てられている場合または特定のラベルがある場合のこのアクションのスキップなど、andymckay/labeler アクションで実行できる追加の機能の詳細については、andymckay/labeler アクションのドキュメントを参照してください。
  • ワークフローをトリガーできるさまざまなイベントの詳細については、「ワークフローをトリガーするイベント」を参照してください。 andymckay/labeler アクションは、issuespull_request、または project_card イベントでのみ機能します。
  • このアクションを使用したワークフローの例については、GitHub を検索 してください。

このドキュメントは役立ちましたか?プライバシーポリシー

これらのドキュメントを素晴らしいものにするのを手伝ってください!

GitHubのすべてのドキュメントはオープンソースです。間違っていたり、はっきりしないところがありましたか?Pull Requestをお送りください。

コントリビューションを行う

OR, コントリビューションの方法を学んでください。

問題がまだ解決していませんか?

GitHubコミュニティで質問するサポートへの連絡