README.md

Issue Digest

A GitHub Action that comments a list of issues. If a discussion with a match title is found, that discussion is used, or a new discussion is created.

Development

1. 🛠️ Install the dependencies

   npm install

2. 🏗️ Package the TypeScript for distribution

   npm run bundle

3. ✅ Run the tests

   npm test

4. 🚀 Build the action, rollup and run test.

   npm run all

Usage

Create a daily discussion (at 08:00 UTC), with a list of issues in the last 24 hours

on:
  schedule:
    - cron: '0 8 * * *'

permissions:
  contents: read
  discussions: write
  issues: read

jobs:
  issue-digest:
    runs-on: ubuntu-latest
    steps:
      - uses: sethrylan/issue-digest@b920bb8465f5a0682caa908ba8d943bc3dfc6129
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Create a weekly discussion every Monday, and comment every day at 08:00 UTC with a list of updated issues

on:
  schedule:
    - cron: '0 8 * * *'

permissions:
  contents: read
  discussions: write
  issues: read

jobs:
  issue-digest:
    runs-on: ubuntu-latest
    steps:
      - id: last
        run: |
          echo "monday=$(date -d 'last Monday' '+%Y-%m-%d')" >> "$GITHUB_OUTPUT"
      - uses: sethrylan/issue-digest@b920bb8465f5a0682caa908ba8d943bc3dfc6129
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          intro: |
            🤖 This discussion was created by issue-digest
            The title of the discussion will be create a new discussion each week, and every time the action runs a comment will be added with a list of issues changed in the last 24 hours.
          comment: |
            Issues updated in the last 24 hours
          title: |
            Issue Digest for Week of ${{ steps.last.outputs.monday }}

Common Errors

Error Resource not accessible by integration

Check the permissions for the calling workflow.

No Isuses are found

Check the permissions for the calling workflow.

Discussion category (General) not found

Check that discussions are enabled for the repository.