はじめに
このチュートリアルでは、imjohnbo/issue-bot アクションを使用して定期的に Issue を作成する方法を説明します。 たとえば、Issue を毎週作成して Team 会議のアジェンダとして使用できます。
チュートリアルでは、最初に imjohnbo/issue-bot アクションを使用するワークフローファイルを作成します。 次に、ニーズに合わせてワークフローをカスタマイズします。
ワークフローの作成
-
このプロジェクト管理ワークフローを適用したいリポジトリを選択してください。 書き込みアクセス権を持つ既存のリポジトリを利用することも、新しいリポジトリを作成することもできます。 リポジトリの作成に関する詳細は「新しいリポジトリの作成」を参照してください。
-
リポジトリに、
.github/workflows/YOUR_WORKFLOW.ymlというファイルをYOUR_WORKFLOWの部分を選択した名前で置き換えて作成してください。 これがワークフローファイルです。 GitHub上での新しいファイルの作成に関する詳しい情報については「新しいファイルの作成」を参照してください。 -
次の YAML コンテンツをワークフローファイルにコピーします。
YAML name: Weekly Team Sync on: schedule: - cron: 20 07 * * 1 jobs: create_issue: name: Create team sync issue runs-on: ubuntu-latest permissions: issues: write steps: - name: Create team sync issue uses: imjohnbo/issue-bot@v3.0 with: assignees: "monalisa, doctocat, hubot" labels: "weekly sync, docs-team" title: "Team sync" body: | ### アジェンダ - [ ] Start the recording - [ ] Check-ins - [ ] Discussion points - [ ] Post the recording ### 議論のポイント 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 }} -
ワークフローファイルのパラメータをカスタマイズします。
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 をクローズしないようにするには、一意のラベルまたはラベルの組み合わせを使用します。
-
ワークフローファイルを、リポジトリのデフォルトブランチにコミットしてください。 詳細は「新しいファイルを作成する」を参照してください。
期待される結果
schedule パラメータ（たとえば、毎週月曜日の 7:20 UTC）に基づいて、ワークフローは、アサインされた人、ラベル、タイトル、本文を使用して新しい Issue を作成します。 pinned を true に設定すると、ワークフローは Issue をリポジトリにピン止めします。 close-previous を true に設定すると、ワークフローはラベルが一致する最新の Issue をクローズします。
ノート: scheduleイベントは、GitHub Actionsのワークフローの実行による高負荷の間、遅延させられることがあります。 高負荷の時間帯には、毎時の開始時点が含まれます。 遅延の可能性を減らすために、Ⅰ時間の中の別の時間帯に実行されるようワークフローをスケジューリングしてください。
ワークフローの実行履歴を表示して、このワークフローが定期的に実行されているかどうかを確認できます。 詳しい情報については、「ワークフロー実行の履歴を表示する」を参照してください。
次のステップ
- アサインされた人のローテーションや Issue テンプレートの使用など、
imjohnbo/issue-botアクションで実行できるその他の操作について詳しくは、imjohnbo/issue-botアクションのドキュメントをご覧ください。 - このアクションを使用したワークフローの例については、GitHub を検索 してください。