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

@kristw-lab/gh-conventional-release

v1.0.0

Published

Creates a new GitHub Release following Conventional Commits

Downloads

89

Readme

gh-conventional-release

Create releases on GitHub based on tags

This was forked and modified from https://github.com/escaletech/circleci-gh-conventional-release

Usage

Plain Node.js

GITHUB_TOKEN="$GITHUB_TOKEN" \
TARGET_TAG="$CIRCLE_TAG" \
REPO_OWNER="$CIRCLE_PROJECT_USERNAME" \
REPO_NAME="$CIRCLE_PROJECT_REPONAME" \
CONTINUE_ON_ERROR="false" \
npx https://github.com/kristw/circleci-gh-conventional-release

CircleCI

Environment variables used for default parameters:

  • GITHUB_TOKEN
  • CIRCLE_TAG (set by default in CircleCI when build is triggered by a tag push)
  • CIRCLE_PROJECT_USERNAME (set by default in CircleCI)
  • CIRCLE_PROJECT_REPONAME (set by default in CircleCI)

Assuming an environment with all the required variables, usage consists of simply calling the create-release job or command:

version: 2.1

orbs:
  gh-release: escaletech/[email protected]

workflows:
  version: 2
  release:
    jobs:
      # ... more jobs
      - gh-release/create-release:
          context: context-with-github-token-env-var

But you can always specify parameters individually:

version: 2.1

orbs:
  gh-release: escaletech/[email protected]

workflows:
  version: 2
  release:
    jobs:
      # ... more jobs
      - gh-release/create-release:
          github-token: ABCXYZ457 # default is $GITHUB_TOKEN
          target-tag: v0.1.2 # default is $CIRCLE_TAG
          repo-owner: your-username # default is $CIRCLE_PROJECT_USERNAME
          repo-name: your-repo-name # default is $CIRCLE_PROJECT_REPONAME

This will result in a GitHub release like the following:

sample

Github Actions

name: New Release

on:
  push:
    tags:
      - "v*"

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Setup Node
        uses: actions/setup-node@v1
        with:
          node-version: 12.x
      - name: Install GH Conventional Release
        run: sudo npm install -g @kristw/gh-conventional-release
      - name: Generate Release
        shell: bash
        run: |
          TARGET_TAG="${GITHUB_REF#refs/*/}" \
          REPO_OWNER="${GITHUB_REPOSITORY%/*}" \
          REPO_NAME="${GITHUB_REPOSITORY#*/}" \
          CONTINUE_ON_ERROR="false" \
          GITHUB_TOKEN="${{ secrets.GITHUB_TOKEN }}" \
          circleci-gh-conventional-release

Github Actions with template

name: New Release

on:
  push:
    tags:
      - "v*"

jobs:
  stage:
    uses: kristw/gh-conventional-release/.github/workflows/create-release-template.yml@master
    name: "Release"
    secrets:
      gh_token: ${{ secrets.GITHUB_TOKEN }}

Development

In order to publish to production you should generate a new tag.

The convenient and proper way to do it is to run the following command:

npm run release