Skip to content

grease@1.0.0 (🎂 First Release)
Compare
Choose a tag to compare
@unicornware unicornware released this 15 Aug 04:15
· 457 commits to main since this release
grease@1.0.0
4a8195d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Overview

grease is a package release workflow tool for Node.js environments. Built on top of the standard-version library, it helps maintainers create releases and upload release assets via the GitHub CLI.

Release notes can be generated using the CHANGELOG entry for the most recent semver tag. Maintainers also have the option of generating blank notes, notes in birthday (first release) format, or skipping note generation entirely.

How It Works

  1. Follow the Conventional Commits Specification in your repository
  2. When ready to release, run grease(options: IGreaseOptions)

grease will then do the following:

  1. Retrieve the current package version by looking at packageFiles,
    falling back to the last git tag (if enabled)
  2. bump the version in bumpFiles based on your commits
  3. Generate a commit-based changelog (uses conventional-changelog under
    the hood)
  4. Create a new commit including bumpFiles and updated CHANGELOG
  5. Create a new tag with the new version number
  6. Check if the GitHub CLI is installed
  7. Generate release notes
  8. Create a new GitHub release
Assets 3
Loading