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 🙏

© 2021 – Pkg Stats / Ryan Hefner

@invisible/release-note

v2.1.2

Published

Publish Release Notes to Slack seamlessly

Downloads

61

Readme

This package is deprecated and will no longer be maintained. Use @invisible/changelog-update instead.

@invisible/release-note

CircleCI

Provides three helper methods to publish the latest additions to your changelog.

assert-release-note

Asserts if there is an addition to your changelog in the current Pull Request.

push-release-note

Pushes the changelog additions to Slack (more adapters will be added in the future).

last-changelog-additions

Logs the latest changelog additions to stdout. If you are on master, looks at the diff from two merges ago. If you are not on master, looks at the diff between master and HEAD

Install

  1. Install the package as devDependency:
yarn add -D @invisible/release-note
# or
npm install -D @invisible/release-note
  1. If you wish to use the push-release-note method, set up a Slack Webhook. NOTE: Slack will reject mutliple POST's to the same webhook that have identical messages, so you might run into this while testing.

Usage

Programmatically

  'use strict'

  const {
    assertReleaseNote,
    lastChangelogAdditions,
    pushReleaseNote,
  } = require('@invisible/release-note')

  // changelogFile defaults to CHANGELOG.md if no argument given
  // This method will throw if no addition has been made to your changelogFile since
  // the last merge commit
  assertReleaseNote({ changelogFile: 'CHANGELOG.txt' })

  const webhookUrl = process.env.CHANGELOG_WEBHOOK_URL

  // This method is async so it returns a promise that resolves the Response object from POST'ing to the Slack webhook
  pushReleaseNote({
    changelogFile: 'CHANGELOG.txt', // defaults to CHANGELOG.md
    iconEmoji: 'joy', // defaults to :robot_face:
    slackbotName: 'Cool Bot Name' , // defaults to Changelog
    webhookUrl,
  }).then(console.log).catch(console.error)

  const notes = lastChangelogAdditions()

  console.log(notes) // or do something cool with it

Hook scripts

assert-release-note

  1. Append assert-release-note to posttest on scripts section of your package.json.
  // It would look something like this:
  "scripts": {
    "posttest": "assert-release-note"
  }

You can also run it at any time from your CLI.

$ assert-release-note

push-release-note

  1. Add to the deployment section of your project circle.yml file the following: - push-release-note
# Your circle.yml should look like the below:
deployment:
  production:
    branch: master
    commands:
      - push-release-note

You can also run it at any time from your CLI.

$ push-release-note
  1. Optional: set a name for your slack bot and an icon emoji in your package.json
  "releaseNote": {
    "slackbotName": "Changelog Robot",
    "iconEmoji": "joy"
  }
  1. If using Circle CI, add the CHANGELOG_WEBHOOK_URL variable to your project. This package will optionally load dotenv if it's present, so you may add this to your .env file as well.

TODO

  • Unit Tests
  • Testing on multiple platforms