Issue の作成をスケジュールする

はじめに

このチュートリアルでは、imjohnbo/issue-bot アクションを使用して定期的に Issue を作成する方法を説明します。 たとえば、Issue を毎週作成して Team 会議のアジェンダとして使用できます。

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

ワークフローの作成

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

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

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

   YAML

   # このワークフローはGitHubによって認定されていないアクションを使用します。
   # それらはサードパーティによって提供され、
   # 別個の利用規約、プライバシーポリシー、
   # サポートドキュメンテーションが適用されます。
   
   name: Weekly Team Sync
   on:
     schedule:
       - cron: 20 07 * * 1
   
   jobs:
     create_issue:
       name: Create team sync issue
       runs-on: ubuntu-latest
       steps:
         - name: Create team sync issue
           uses: imjohnbo/issue-bot@3daae12aa54d38685d7ff8459fc8a2aee8cea98b
           with:
             assignees: "monalisa, doctocat, hubot"
             labels: "weekly sync, docs-team"
             title: "Team sync"
             body: |
               ### Agenda
   
               - [ ] Start the recording
               - [ ] Check-ins
               - [ ] Discussion points
               - [ ] Post the recording
   
               ### Discussion Points
               Add things to discuss below
   
               - [Work this week](https://github.com/orgs/github/projects/3)
             pinned: false
             close-previous: false
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

4. ワークフローファイルのパラメータをカスタマイズします。

   • on.schedule の値を変更して、このワークフローの実行日時を指定します。 上記の例では、ワークフローは毎週月曜日の 7:20 UTC に実行されます。 スケジュールされたワークフローの詳細については、「スケジュールされたイベント」を参照してください。
   • assignees の値を、Issue に割り当てる GitHub ユーザ名のリストに変更します。
   • labels の値を、Issue に適用するラベルのリストに変更します。
   • title の値を、Issue に付けるタイトルに変更します。
   • body の値を、Issue の本文に必要なテキストに変更します。 | 文字を使用すると、このパラメータに複数行の値を使用できます。
   • この Issue をリポジトリにピン止めする場合は、pinned を true に設定します。 ピン止めされた Issue の詳細については、「リポジトリに Issue をピン止めする」を参照してください。
   • 新しい Issue が作成されるたびにこのワークフローで生成された以前の Issue をクローズする場合は、close-previous を true に設定します。 ワークフローは、labels フィールドでラベルが定義されている最新の Issue を閉じます。 間違った Issue をクローズしないようにするには、一意のラベルまたはラベルの組み合わせを使用します。

5. ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてください。 詳細は「新しいファイルを作成する」を参照してください。

期待される結果

schedule パラメータ（たとえば、毎週月曜日の 7:20 UTC）に基づいて、ワークフローは、アサインされた人、ラベル、タイトル、本文を使用して新しい Issue を作成します。 pinned を true に設定すると、ワークフローは Issue をリポジトリにピン止めします。 close-previous を true に設定すると、ワークフローはラベルが一致する最新の Issue をクローズします。

ワークフローの実行履歴を表示して、このワークフローが定期的に実行されているかどうかを確認できます。 詳しい情報については、「ワークフロー実行の履歴を表示する」を参照してください。

次のステップ

• アサインされた人のローテーションや Issue テンプレートの使用など、imjohnbo/issue-bot アクションで実行できるその他の操作について詳しくは、imjohnbo/issue-botアクションのドキュメントをご覧ください。
• このアクションを使用したワークフローの例については、GitHub を検索 してください。