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 🙏

© 2022 – Pkg Stats / Ryan Hefner

@nona-creative/semantic-release-latest-release-notes

v1.0.1

Published

A plugin to write the latest release notes to files that you specify in either markdown or plain text

Downloads

13

Readme

Semantic Release Latest Release Notes

Writes the latest release notes for Semantic Release to the files of your choice, in either Markdown or Plain Text format.

Table of Contents

Purpose Of This Plugin

When deploying mobile applications to the Play Store or Testflight, it's often useful to the latest release notes supplied by Semantic Release as plain text, so that they can be supplied as part of the what to test next notes.

This plugin allows you to write these notes out to a file or files, in either Plain Text (strips the markdown from generated release notes) or Markdown format.

Usage

The plugin can be configured in the semantic-release configuration file

An example usage in .releaserc could be e.g:

{
  "branches": [
    "your-branch"
  ],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator"
    [
      "semantic-release-latest-release-notes",
      {
        "latestReleaseNotesTitle": "# What's New",
        "latestReleaseNotesFile": "docs/latest-release-notes",
        "latestReleaseNotesFormats" : ["text", "markdown"]
      }
    ],
    "@semantic-release/github",
    "@semantic-release/npm",
  ]
}

With this example, for each release, a docs/latest-release-notes.md and docs/latest-release-notes.txt file will be created or overwritten.

⬆ back to top

Configuration

Options

The following options may be passed to the plugin:

  • latestReleaseNotesTitle: a string specifying the title to use for the latest release notes. E.g. # What's New. Default is latest-release-notes
  • latestReleaseNotesFile: a string specifying the file path and name to write the outputs to (without an extension). E.g. latest-release-notes. Default is # Latest Release Notes
  • latestReleaseNotesFormats: a an array of formats to write the output in. Current formats include text and markdown. Default is ['text', 'markdown']

⬆ back to top

Available Commands

To see a list of available commands in this package when cloning the repo run:

npm run help

⬆ back to top

Additional Docs

⬆ back to top

Quick Start For Development

  1. go through all the Prerequisites in Prerequisites
  2. npm i install NPM dependencies
  3. npm run build build the package

⬆ back to top

Testing

We use Jest for testing. To run unit tests, you can use one of the following commands, to run once, run in watch mode, or to run all tests and generate converage reports.

npm run test
npm run test:watch

⬆ back to top