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

@pictarine/release-note-now

v1.0.8

Published

Automatic release note generator for GitHub projects

Downloads

50

Readme

Release Note Now

Automatic release note generator for GitHub projects.

Install

Just install as NPM dependency.

npm install @pictarine/release-note-now --save

Run

For easy access, add a script into your package.json :

{
  "scripts": {
    "rn": "release-note-now"
  }
}

Launch example :

npm run rn \
  -- \
  -t ${{ secrets.GITHUB_TOKEN }} \
  -r Pictarine/my_ios_repo \
  -v "xcconfig:Shared/Supporting Files/Main.xcconfig"

Options

    --help     Show help                             [boolean]
-t, --token    GitHub Token                          [required]
-r, --repo     GitHub repository (owner/repo)        [required]
-b, --branch   Github branch                         [optional] [default: the default branch of the repo]
-k, --keys                                           [required] [default: "feat:Features,fix:Fixes"]
-v, --version                                        [required]
-s, --style    Commit message style (full/short)     [optional] [default: full]

For the -k option, you can define any key+title that will be searched in commit list.

  • For example, "config:Configuration" will search every commit starting with "[Config]" (uppercased/lowercased), then print them in "Configuration" section in your release note.

The -v option supports three types of versionning right now:

  • xcconfig:<path_to_xcconfig> : Search for an xcconfig file, then extract VERSION_NUMBER + BUILD_NUMBER to generate tag
  • increment:<increment_count> : The next tag will increment the last tag + your increment count
  • package.json:<path_to_file> : Take the version in package.json file