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

@public-js/cc-github-releaser

v2.0.3

Published

Create GitHub releases from git metadata

Downloads

16

Readme

@public-js/cc-github-releaser

Build Version Downloads Size

CodeQL Codacy Codecov Code Climate

Create GitHub releases from git metadata


Installing

Add the package to your project by running:

npm i -D @public-js/cc-github-releaser

Create a new token or use an existing one. Make sure the token you're going to use has a public_repo scope (or repo for private repositories).

Assign you token to any of the following env variables: GITHUB_TOKEN, GH_TOKEN, CONVENTIONAL_GITHUB_RELEASER_TOKEN or pass it with any of these parameters: -t or --token.

Workflow setup

For you convenience, you might want to add the following to your root package.json file:

"scripts": {
  "github-release": "cc-github-releaser"
}

Execute it from you workflow like this:

run: npm run github-release

Recommended workflow

  • Commit your changes
  • Make sure you build/tests pass
  • Bump version with any tool e.g. standard-version or do it manually then commit the change
  • Create & push a version tag e.g. 1.2.3
  • Execute cc-github-releaser to create a release

If you want a more fancy release process, check out this workflow.

Package size

Although Package Phobia reports this package to be pretty heavy, keep in mind that:

  • This package should not be bundled with your distribution
  • You probably already have at least half of its dependencies' installed
  • This package allows a lot of flexibility in dependencies' versions

Resources

License

MIT, full license text. Read more about it on TLDRLegal.