GitHub Action Release Notes

GitHub Action Release Notes is a CLI that helps project maintainers generate standardised GitHub release notes and changelogs from tags, issues, or commits.

  • Automation
  • Development
  • Tools & Utilities
GitHub Action Release Notes is a CLI that helps project maintainers generate standardised GitHub release notes and changelogs from tags, issues, or commits.

Platform availability

Available on 0 of 10 platforms

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

20/100 Low

Maintained
0last commit 2067 days ago
Popular
59895 GitHub stars
Easy to install
100 install platforms, Docker image
Light to run
No data
Security check
201 serious finding, 17 minor, tests, OpenSSF Scorecard 3.6/10

Based on 4 of 5 factors.

GitHub stars
895
Open issues
94
Last commit
2021-03-25
Latest release
0.17.3
License
GPL-3.0
Activity
stale

Checked 3 days ago - source: GitHub (github-tools/github-release-notes)

Resources & Compatibility

Requirements not published yet.

Checked 23 days ago - source: Docker Hub image tags and published docs

First-install notes

No first-install notes yet.

Alternatives

No alternatives collected yet.

Common questions

Can it create a release and compile release notes automatically?

Yes. It can create a release from a tag and compile the release notes using issues or commits.

How does it decide which commits to include?

It is described as a Node module to publish release notes based on commits between the last two tags.

Can it also generate a changelog file?

Yes, it can generate a CHANGELOG.md file based on the release notes or create a brand new one.

If I use the create-release GitHub Action, will it generate notes too?

No. That action can create a release but does not handle generating the release notes by itself.

How can I troubleshoot a self-hosted runner that runs the action?

You can monitor self-hosted runners to view their activity and diagnose common issues.

Answers sourced from docs.github.com, github-tools.github.io, github.com, stackoverflow.com

Community

Collected 48 days ago - public community threads