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

@release-notes/cli

v0.3.0

Published

CLI tool for managing 'Release Notes' - An easy to use, human readable and machine processable schema for release notes.

Downloads

14

Readme

Release Notes CLI

Subscribe to Release Notes NPM Package Build Status MIT license

About

Release Notes CLI is a console tool for automated release notes management around traditional CHANGELOG files and our generalized Release Notes Schema Specification.

Installation

$ yarn global add @release-notes/cli
# or
$ npm i -g @release-notes/cli

Usage

$ release-notes -h

release-notes <command> [args]

Commands:
  release-notes init [file]      Initialize release notes file
  release-notes convert [file]   Convert release notes to another format
  release-notes validate [file]  Validate release notes file
  release-notes publish [file]   Publish release notes file to the hub
                                 (https://release-notes.com)

Options:
  --version, -v  Show version number
  --help, -h     Show help

Initialize Release Notes

$ release-notes init [options] [file]

Parameter | Default Value | Description :----------|:---------------------|:----------- --help, -h | false | Show help --file, -f | "./release-notes.yml" | Path to the release-notes.yml file to create. --title, -t | "Release Notes of something awesome" | Title of the project --description, -d | empty | Project description. Can be passed multiple times.

Example

If you want to initialize a new release-notes.yml file in your current working directory:

$ release-notes init --title 'Release notes of an awesome project.' \
    -d 'You can pass multiple lines of description' \
    -d 'This is a second line of description'

Convert Release Notes

$ release-notes convert [options] [file]

Parameter | Default Value | Description :----------|:---------------------|:----------- --help, -h | false | Show help --file, -f | "./release-notes.yml" | Path to some release-notes or CHANGELOG file --type, -t | empty - required | The converter to use. Possible values are ["json", "release-notes", "yml", "changelog", "md"]

Convert a CHANGELOG.md file into a release-notes.yml definition:

$ release-notes convert -t release-notes CHANGELOG.md > release-notes.yml

Converts the release-notes.yml file in the cwd to json and print it to stdout:

$ release-notes convert -t json

Convert a release-notes.yml file to a CHANGELOG.md:

$ release-notes convert -t changelog path-to/release-notes.yml > CHANGELOG.md

Print all released versions

The following command rely on jq a json processor for the console.

# show versions of the ./release-notes.yml file
$ release-notes convert -t json | jq .releases[].version

# or of a CHANGELOG.md file
$ release-notes convert -t json path-to/CHANGELOG.md | jq .releases[].version

Validate Release Notes

$ release-notes validate [options] [file]

Parameter | Default Value | Description :----------|:---------------------|:----------- --help, -h | false | Show help --file, -f | "./release-notes.yml" | Path to a release-notes.yml file.

Validate the release-notes.yml file in the CWD:

$ release-notes validate

The command will exit with code 0 on success. Any other exit code can be treated as failure.


Publish Release Notes

$ release-notes publish [options] [file]

In order to publish some release notes to the release notes hub run:

$ release-notes publish \
    --scope my-user-name \
    --name some-package-name \
    --token PMxU6hEiLQPdoGkKy8rij1qsgrQmplk5gvWdJWubrNg= \
    ./CHANGELOG.md

This would publish your ./CHANGELOG.md definition to https://release-notes.com/@my-user-name/some-package-name.

You can also pass the parameters via environment variables, which may be handy.

Parameter | Environment variable | Description :----------|:---------------------|:----------- --scope, -s | RELEASE_NOTES_SCOPE | Your release-notes hub username --name, -n | RELEASE_NOTES_NAME | Your release notes handle (only numbers, letters and dashes) --file, -f | RELEASE_NOTES_FILE | Path to a CHANGELOG.md or release-notes.yml file (default ./release-notes.yml) --token, -t | RELEASE_NOTES_TOKEN | Your release-notes api token see (https://release-notes.com/auth-tokens)

Project Repositories


LICENSE

The files in this archive are released under MIT license. You can find a copy of this license in LICENSE.