Skip to content

Checklist Progress Badge

Actions
Update readme file with badges generated from repos checklists
v0.1
Latest
Star (2)

Example-TODO Example-Checklist-NFR

gha-nfr-checklist-badges

Example USAGE:

  1. Create .md file with checklist (Look at examples/ dir)
  2. Create .github/workflows/nfr_on_push.yaml with content:
name: NFR documents changed
on:
  workflow_dispatch:
  push:
    paths:
      - "*.md"
jobs:
  push:
    name: NFR documents changed
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: Update NFR badges
        uses: dodopizza/gha-checklist-badges@main
        with:
          readme-fname: README.md
          nfr-fnames: ChecklistFileOne.md ChecklistFileTwo.md
          github_token: ${{ secrets.GITHUB_TOKEN }}
  1. Now, your README.md will be automatically updated with auto-generated badges following ChecklistFileOne.md/ChecklistFileTwo.md changes

Checklist Progress Badge is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Update readme file with badges generated from repos checklists
v0.1
Latest

Checklist Progress Badge is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.