npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@eqworks/release

v3.5.3

Published

A CLI for changelog and release notes generation based on tags and commit history.

Downloads

55

Readme

release

A CLI for changelog and release notes generation based on tags and commit history.

Installation

If you have npx available, you can directly use it without explicit installation:

% npx @eqworks/release --help

Otherwise, or when explicitly local installation is needed:

% yarn global add @eqworks/release
% # or
% npm i -g @eqworks/release

Then:

% release --help

Usage

For best formatting result, follow the conventions below:

category - message

Where category can have a sub-category following a forward slash /.

main-category/sub-category - message

For example:

builder/details - show job viz for newly created, unprocessed jobs

Since v1.3.0, a generic others category is added to capture all unparsed commit messages.

Check the detailed git conventions for more details.

Changelog (by label)

In any git repo (suppose the tagging pattern is v*, you can use --pattern option to fit yours), run:

% npx @eqworks/release changelog --print --skip alpha

The result is in markdown formatted changelog.

Since v2.0.0, an NLP-based auto labelling mechanism has been added, along with the sub-command changelog intended for changelog-like formatting (as shown above).

Since v3.0.0, the NLP model has been retrained to adhere to Keep a Changelog conventions.

Notes (by category)

The sub-command notes can be used for more category-oriented formatting:

% npx @eqworks/release notes --print --skip alpha

The result is in markdown formatted release notes.

Tag

Since v3.1.0, the sub-command tag identifies the version inside the commit messages and can either create a local tag with the commit version as its name or make a GitHub release using the --github flag:

% npx @eqworks/release tag --github

The above command reads from the latest three commits (by default, change with the -n flag.)

Important note for Node.js 18

When running the CLI commands on Node.js 18, you may need to add the --no-experimental-fetch flag to the NODE_OPTIONS environment variable. This flag is required to disable the experimental fetch feature introduced in Node.js 18.

To execute the CLI commands with the --no-experimental-fetch flag, use the following syntax:

% NODE_OPTIONS=--no-experimental-fetch npx @eqworks/release <command>