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

yarn-outdated-notifier

v1.1.0

Published

Add link to CHANGELOG the result of `$ yarn outdated`, and notify to GitHub Issue.

Downloads

123

Readme

:rocket: yarn-outdated-notifier

npm CircleCI

Add link to CHANGELOG the result of $ yarn outdated, and notify to GitHub Issue.

Example Issue

2018-03-01 Yarn Outdated Notifier

Issue URL: https://github.com/tsuyoshiwada/yarn-outdated-notifier-with-circleci/issues/2

Motivation

Overview

yarn-outdated-notifier will help you update the npm package on which you depend.

1. Keeping fresh package

yarn has a useful toolset for updating npm packages like yarn outdated and yarn upgrade-interactive. Utilize these tool sets to visualize packages that need updating and register them to GitHub Issue.

2. Understand the changes

The problem with updating the npm package is that unintended changes destroy the project. By checking CHANGELOG prepared by each package, it is possible to solve this problem to a certain extent.

Therefore, yarn-outdated-notifier adds a link to CHANGELOG to the result of yarn outdated and notifies.


Since CircleCI and TravisCI have the function of cron, you can use it to make periodic package update notifications :tada:

Installation

$ yarn add -D yarn-outdated-notifier

Usage

Please access the page of Personal access tokens and issue a token. You need the scope of repo.

By passing the issued token to the --api-token option and executing the command, we will inform GitHub's Issue of the result of $ yarn outdated.

$ yarn outdated-notifier --help

  Add link to CHANGELOG the result of `$ yarn outdated`, and notify to GitHub Issue.

  USAGE:
    $ outdated-notifier [options]

  OPTIONS:
    --api-token         API token for GitHub (required)
    --github-api-url    provide url for GitHub enterprise (default: "api.github.com")
    --owner,      -o    repository owner name (default: "git config --get remote.origin.url" infomation)
    --repository, -r    repository name (default: "git config --get remote.origin.url" infomation)
    --title,      -t    issue title for GitHub
    --labels,     -l    issue labels name for GitHub
    --assignees,  -a    issue assignees name for GitHub
    --excludes,   -e    path to yaml file which specify package names to exclude
    --changelogs, -c    path to yaml file which specify changelog uris for the packages
    --template          path to the template to use for notification
    --dry-run           do not register on issue, output contents to stdout
    --help,       -h    show help
    --version,    -v    print the version

  EXAMPLES:
    $ yarn outdated-notifier --api-token <your_personal_token>
    $ yarn outdated-notifier --api-token <your_personal_token> --labels "label_name" --assignees "assignee_name"
    $ yarn outdated-notifier --api-token <your_personal_token> --template "./template.hbs"
    $ yarn outdated-notifier --api-token <your_personal_token> --changelogs "./changelogs.yml"
    $ yarn outdated-notifier --api-token <your_personal_token> --changelogs "./changelogs.yml" --excludes "./excludes.yml"

Prepare the CHANGELOG link

Please create a YAML file with the package name and the link to CHANGELOG in the format shown below and specify it in the --changelogs option. (e.g. changelogs.yml)

react: https://github.com/facebook/react/blob/master/CHANGELOG.md
lodash: https://github.com/lodash/lodash/wiki/Changelog
moment: https://github.com/moment/moment/blob/develop/CHANGELOG.md
...

Thanks

Contribute

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :love_letter:

Bugs, feature requests and comments are more than welcome in the issues.

License

MIT © Cyberagent, Inc