github-release-notes
Advanced tools
Node module to publish release notes based on commits between the last two tags.
Node module that generates release notes based on commit messages or closed issues between tags. It also can create a full changelog or add the latest release notes to the existing changelog file.
If you want to include it in a task, you can use grunt-github-release-notes
Install github-release-notes via npm:
npm install github-release-notes -g
First generate a github token at this link. You only need "repo" scope.
Then add this to ~/.bash_profile or ~/.zshrc):
export GREN_GITHUB_TOKEN=your_token_here
# Navigate to your project directory
cd ~/Path/to/repo
# Run the task
gren
Otherwise, you can run it anywhere passing the repo information:
gren --username=[username] --repo=[repo name]
To use a specific token you can specify it as option:
gren --token=[your token]
Gren has two main usages: release and changelog.
You can select the action with the --action option.
FAQs
Create a release from a tag and uses issues or commits to creating the release notes. It also can generate a CHANGELOG.md file based on the release notes (or generate a brand new).
The npm package github-release-notes receives a total of 536 weekly downloads. As such, github-release-notes popularity was classified as not popular.
We found that github-release-notes demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.