https://github.com/jessety/automated-releases-example
Example Node project with automated GitHub releases
https://github.com/jessety/automated-releases-example
boilerplate github-actions github-actions-node github-releases
Last synced: about 1 month ago
JSON representation
Example Node project with automated GitHub releases
- Host: GitHub
- URL: https://github.com/jessety/automated-releases-example
- Owner: jessety
- License: mit
- Created: 2020-07-12T21:57:48.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2020-12-08T18:19:14.000Z (over 5 years ago)
- Last Synced: 2025-06-11T22:48:43.582Z (12 months ago)
- Topics: boilerplate, github-actions, github-actions-node, github-releases
- Language: Handlebars
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Automating GitHub Releases
This is an example Node project that leverages [actions/create-release](https://github.com/actions/create-release) and [auto-changelog](https://www.npmjs.com/package/auto-changelog) to automate the creation of GitHub releases, complete with release notes generated from the commit log with a customizable template.
## Usage
To publish a new release, create a tag and push to GitHub. The release is published server-side in an Actions workflow.
```bash
npm version patch
git push --follow-tags
```
When a new tag that begins with `v` (e.g. `v1.2.0`, `v3.0.1`, etc.) is pushed to GitHub, the `release` workflow runs. It generates release notes by running `auto-changelog`, then uses the `create-release` action to publish a new release.
Release notes are created based on the `RELEASE.md.bhs` template file. The template is populated with references to all commits between the last two tags, rendered into Markdown, then piped into the `create-release` action.
## License
MIT © Jesse Youngblood