Backlog Status Checker

Produce a document with an overview of your backlog. This can be executed as a script with minimal dependencies or via the provided GitHub Action. The result can be injected into another document such as a README.md or uploaded to a service like GitHub Pages. It is recommended to define a convenient schedule to pull in updates from your issue tracker.

Have a look at the demo hosted on GitHub Pages!

Inputs

config

By default a file queries.yaml is expected to contain the queries and limits for your project.

args

Additional arguments affecting the behavior of the script:

--reminder-comment-on-issues can be added here to enable automatic reminder comments. This is not enabled by default because it's designed to be used in scheduled runs. Manual execution and previews of changed queries are not expected to have side-effects.

--exit-code can be added to also emit return code 3 if any of the configured queries is not within its limit.

folder

The output folder for the generated HTML. By default this is gh-pages.

redmine_api_key

For the action to be able to access the Redmine API you need to configure REDMINE_API_KEY via Settings > Secrets. In Redmine itself you can create or lookup the key under My Account > API Access key.

Continuous updates

on:
  schedule:
  - cron: '*/10 * * * *'
permissions:
  contents: write
jobs:
  backlogger:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: openSUSE/backlogger@main
        with:
          redmine_api_key: ${{ secrets.REDMINE_API_KEY }}
          args: --reminder-comment-on-issues
      - uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: gh-pages
          clean-exclude: pr-preview

Previews for pull requests

concurrency: preview-${{ github.ref }}
on:
  pull_request_target:
    types:
      - opened
      - reopened
      - synchronize
      - closed
    branches:
      - "**"
permissions:
  contents: write
  pull-requests: write
jobs:
  backlogger:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: openSUSE/backlogger@main
        with:
          redmine_api_key: ${{ secrets.REDMINE_API_KEY }}
      - uses: rossjrw/pr-preview-action@v1

Note

rossjrw/pr-preview-action doesn't support forked repositories. Note the use of pull_request_target and branches as a work-around with the caveat that previews only show HTML changes.

License

This project is licensed under the MIT license, see LICENSE file for details.