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

@postman/yankee

v1.1.0

Published

Easy release management with YAML changelogs

Downloads

772

Maintainers

jacob.zebajacob.zebasteven.tansteven.tanssharadssharadvishwas-rawat9vishwas-rawat9kseniia.lukovakseniia.lukovarishavbharti-postmanrishavbharti-postmanbrekk.bockrathbrekk.bockrathdylanglennpostmandylanglennpostmanakarshts007akarshts007ankiteshankiteshpost-abhigyanpost-abhigyanaravindrajraravindrajrarpitsuman601arpitsuman601nelly_ghazaryannelly_ghazaryaneeroreerorgopikrishna.sgopikrishna.syashasvi13yashasvi13dylansddylansdvivek.nigamvivek.nigamkundan.kumar09kundan.kumar09soumya.agarwal.postmansoumya.agarwal.postmandashrath.yadavdashrath.yadavayush.shrivastavayush.shrivastavsouris.ashsouris.ashprateek.postmanprateek.postmanamaldinesh7amaldinesh7tree6789tree6789saifali_postmansaifali_postmanandrusyshynandrusyshynadarsh.agrawaladarsh.agrawalekam.waliaekam.waliaabhishekpostmanabhishekpostmannabeel.nnabeel.nvasudha.madugulavasudha.madugulajj.liujj.liusaksham-postmansaksham-postmanmmocarskimmocarskipostman-maddiepostman-maddieyashkumarkyashkumarkigor-fesenko-postmanigor-fesenko-postmankhudadad.nomanikhudadad.nomaniaris.villarealaris.villarealpraveen.thirumuruganpraveen.thirumuruganamit-gpamit-gpchowwinstonpostmanchowwinstonpostmanharsh.poddarharsh.poddarmatthew.pinskermatthew.pinskeranimesh.jajooanimesh.jajoonimish.agrawalnimish.agrawalkaran-chawla1karan-chawla1yash.gupta007yash.gupta007josh-postmanjosh-postmanchoowon.sirchoowon.sirchristianareas-postmanchristianareas-postmantch-postmantch-postmanvaibhaw.kumarvaibhaw.kumarabhishek_postmanabhishek_postmansoumadeep.acharyasoumadeep.acharyaaquibjr-postmanaquibjr-postmankrishna-postmankrishna-postmanalex.mortonalex.mortonsalilgupta_postmansalilgupta_postmansteeve.betesteeve.betezubair.lawrencezubair.lawrencemxdavismxdavismxdavis-postmanmxdavis-postmanshy.alter.postmanshy.alter.postmaneric-postmaneric-postmandmytro.markovdmytro.markovabhishek.pawarabhishek.pawarabhishek.raj87abhishek.raj87eddie.davieseddie.daviesshubham.shukla-postmanshubham.shukla-postmanbasile.barrinciobasile.barrinciohoanguyennhoanguyennshreyansh.goyalshreyansh.goyalharikrishna.postmanharikrishna.postmansajal001sajal001dima-postmandima-postmanihor.mariichynihor.mariichynandrii.lymychandrii.lymychmichael.browningmichael.browningyevhenii.stepanovyevhenii.stepanovakshat-nemaakshat-nemapostman-web-platform-functional-accountpostman-web-platform-functional-accountian.cundiffian.cundiffrebecca.krosnickrebecca.krosnicksoriatsoriatmeetsuraj2meetsuraj2nitish-postmannitish-postmanshub_postmanshub_postmanjoshnedelkapostmanjoshnedelkapostmankevin.corbettkevin.corbettcarlos.garcia.postmancarlos.garcia.postmananirudh.msanirudh.msakira28akira28cecilytorocecilytorosumedha.kulkarnisumedha.kulkarnisuman.dassuman.dasyashishduayashishduarljohnsnrljohnsnsalomekbg_postmansalomekbg_postmanvtysonvtysonindraneel_postmanindraneel_postmangrantkingpostmangrantkingpostmanshivangibajpai12shivangibajpai12abhilash-postmanabhilash-postmanraghavendra-postmanraghavendra-postmanravi-postmanravi-postmanjedliu-postmanjedliu-postmanamaan.khan.postmanamaan.khan.postmandiwakarshukla_postmandiwakarshukla_postmanimran.munirimran.munirmarkgritterpmmarkgritterpmshruthiveeshruthiveeaki-kusanagiaki-kusanagiyokawasayokawasaankit834ankit834saurabh.agarwalsaurabh.agarwalitsaamirpostmanitsaamirpostmanpostmanautpostmanautnoah.schwartznoah.schwartzdkrapedkrapesaurabh.vartaksaurabh.vartakwheatspaghettiwheatspaghettihimanshu.ng056himanshu.ng056honeynairhoneynairtonyzebastiantonyzebastianparthvermaparthvermaneha.kauraneha.kaurajosephpsjosephpsparthpvermaparthpvermamuskaan06muskaan06akshay_postmanakshay_postmanjeroenvdpolljeroenvdpollharsuyashharsuyashayush.chowdhuryayush.chowdhuryplgahplgahsobtiankitsobtiankitsmoyasmoyamcturcomcturcoskatikiaskatikiadhinesh.sridhardhinesh.sridharaman-pmaman-pmalexgul4enkoalexgul4enkopamzanipamzaniguru.pochineniguru.pochineninavneetbholenavneetbholepiyush.dagapiyush.dagahimanshu.vishwakarmahimanshu.vishwakarmashraddha-arora-postmanshraddha-arora-postmananshitbansalanshitbansalprathameshhprathameshhnitishpostmannitishpostmanyashja.inyashja.invarshini59varshini59aviralpostmanaviralpostmantheerthasenantheerthasenanshikharpostmanshikharpostmanamanpostmanamanpostmangreenblade29greenblade29anuragmewaranuragmewarchris_pmchris_pmjk-postmanjk-postmantphippstphippsakshay.kulkarniakshay.kulkarnivedkribhuvedkribhusamarth.gulatisamarth.gulatirazvi07razvi07cleveromcleveromplanetabhiplanetabhitiara.johnsontiara.johnsonjoe.fuscojoe.fuscojonathanhavivjonathanhavivmudit.joshimudit.joshipiyush.rpiyush.ranjali2022anjali2022gkorosc-postmangkorosc-postmanraisintenraisintenitsaamiritsaamirvinayak.parasharvinayak.parasharrafaeltfrafaeltfapoorv.gupta.postmanapoorv.gupta.postmanadrian.santanaadrian.santanakylerrenn94kylerrenn94jelle.vandeveldejelle.vandeveldeatanas.aatanas.asamithjaganathsamithjaganathpranavj2000pranavj2000pwitcherpwitcheranandh619anandh619diegog24diegog24kevinswiber-postmankevinswiber-postmansanketpathsanketpathopi-danihelkaopi-danihelkaarvind.khadriarvind.khadricboornaziancboornazianirena-postmanirena-postmanrohan.groverrohan.grovervincentbarthvincentbarthaniketbewalaniketbewalromulo-nascimentoromulo-nascimentoruben.barautruben.barautarsh_13arsh_13rtlockwoodrtlockwoodharshit.kocharharshit.kocharauddypostmanauddypostmanpatricksevatpatricksevatakinard-pmakinard-pmlaszlogreczilaszlogreczibhoomikaduapostmanbhoomikaduapostmanroy-himanshuroy-himanshunidhi_goyalnidhi_goyalalexander-rubiaalexander-rubiaarjun.golabhanviarjun.golabhanvianil.jnanojianil.jnanojigbadebo.bellogbadebo.bellojatin-postmanjatin-postmanbharadwajpoduri7bharadwajpoduri7liteshpatil17liteshpatil17tilak-patel-postmantilak-patel-postmanhasnain.rajanhasnain.rajanelizabeth.fungelizabeth.fungpreetham.mpreetham.mdhuhindhan.ilangodhuhindhan.ilangonishat.sayyednishat.sayyedrubencasasrubencasassterling.chin-postmansterling.chin-postmananubhav-vatsanubhav-vatstimhalltimhallasutosh.sahooasutosh.sahooprasant.patelprasant.patelbot_marketing_engineeringbot_marketing_engineeringshreyansh_postshreyansh_postvaishnavichallavaishnavichallalorenzo.ambrosilorenzo.ambrosiarnaudlauret_postmanarnaudlauret_postmanchristina.hastenrathplus1christina.hastenrathplus1postman-dakshraj.sharmapostman-dakshraj.sharmaekansh-01ekansh-01devsharmadevsharmaayushman9454ayushman9454tonygotonygopostmanianpostmaniandavidtran33davidtran33akkeshavanakkeshavanrishabh.shuklarishabh.shuklariyasainiriyasainiyash-postmanyash-postmankarnsharmakarnsharmapriyambadamadalapriyambadamadalasuhas_gaikwadsuhas_gaikwaddarshan.sendarshan.senyatin1997yatin1997kartikjkartikjsaswatdssaswatdssujayvenaiksujayvenaikkratigyakratigyashubham.ranjanshubham.ranjandavidespidavidespinumaanashrafnumaanashrafshamasisshamasisabhijitkaneabhijitkanehg07hg07kamalaknnkamalaknnnikithaachhininikithaachhinishreyas.pandurangashreyas.pandurangapratiksolimpratiksolimsivcansinghsivcansinghbhargavkaranam96bhargavkaranam96ronak.npmronak.npmcodenirvanacodenirvanatristandenyertristandenyersabih.siddiquisabih.siddiquishashwat.dixitshashwat.dixitkriss1897kriss1897gunjan4542gunjan4542meetdevelopermeetdeveloperpawanbanapawanbanashreyshahshreyshahvshingalavshingalabarshan23barshan23coditvacoditvaskrplskrpljibinmathews7jibinmathews7diudadiudapostbot-bitbucketpostbot-bitbucketpostbot-buildkitepostbot-buildkitedannydaintondannydaintonbrandonmcastillobrandonmcastillomichaelclausmichaelclausdevansh21devansh21arshad.ayubarshad.ayubsharma.nikhil1997sharma.nikhil1997smitshah173smitshah173atishay-postmanatishay-postmansaket_ranjansaket_ranjandhawan29dhawan29arlemi.postmanarlemi.postmanpankajk0791pankajk0791mdamankhmdamankhapoorvajain08apoorvajain08arvind-kalraarvind-kalradip_postmandip_postmanakshay24akshay24chetan.waingankarchetan.waingankarbalakrishna.avulapatibalakrishna.avulapatiharsha.dixitharsha.dixitsaialekhya.yerraguntasaialekhya.yerraguntapranav.singhalpranav.singhalamrindersandhuamrindersandhudeepanshuranadeepanshuranamudit1804mudit1804prashant-raghuprashant-raghuwaseem.siddiquiwaseem.siddiquihemendra.kumarhemendra.kumarbswisherbswisherhimanshu0809himanshu0809avinashchoudharyavinashchoudharygouthamajgouthamajtim.beauchamptim.beauchampamrit_vyasamrit_vyasayush.rajayush.rajbrent.cromartybrent.cromartysandeep.singhsandeep.singhabhijeetboroleabhijeetborolemehul.agrawalmehul.agrawalsonymathewsonymathewhardik286hardik286appurvamurawatappurvamurawatphani-postmanphani-postmanchinmayj195chinmayj195harsh_bansalharsh_bansalsrinivas.kinisrinivas.kinijony.cheung.postmanjony.cheung.postmanrrc083rrc083diya.ninandiya.ninanshruti_paranjapeshruti_paranjapeutsav.kapoor1994utsav.kapoor1994abhishek_sabhishek_ssubhash.yadavsubhash.yadavpankajkumar05pankajkumar05prithvi.tharunprithvi.tharunashish.gupta1ashish.gupta1bot.npm.cf.starshipbot.npm.cf.starshipmeenakshi.dhananimeenakshi.dhanani

Readme

yankee

Easy release management with YAML changelogs

Installation

# As a global command:
npm install --global @postman/yankee

# …or locally for an npm project:
npm install --save-dev @postman/yankee

Usage

yankee [<path>]
yankee --help

Description

The file Changelog.yaml is the single source of information about your releases. It should be an object with one key per release and an optional unreleased: key at the top. Here’s an example:

unreleased:
  new features:
    - The cool new flag `--verbose`.

2.0.1:
  date: 1992-02-09
  fixed bugs:
    - Got rid of a nasty IO bug.
    - Improved the docs.

2.0.0:
  date: 1982-03-15
  breaking changes:
    - API redesign. See the readme for details.

1.0.0:
  date: 1970-01-01
  note: Initial release.

When you call yankee, we’ll determine what version number comes next and update the file accordingly. We’ll replace unreleased: with the new version and add a date: property with the current day right below that.

If the unreleased: object contains the key breaking changes:, we’ll make it a major release (X.y.z). If it contains the key new features:, we’ll make a minor bump (x.Y.z). Otherwise, make sure your unreleased: changelog has the key fixed bugs: - we’ll release it as a patch (x.y.Z).

The version number against which we’ll be bumping is the first key in your Changelog.yaml except unreleased:. If there’s no other key, we’ll always tag the release as 1.0.0.

If you call yankee without any options, we’ll only output the version number, so that it’s easy for you to process with scripts.

Options

[path]

The path to your project directory. Should contain a Changelog.yaml. Default: $(pwd).

-n, --npm

Attempt to update the version field in package.json and npm-shrinkwrap.json.

-c, --commit

Commit changes. The commit message will be the raw version number.

-t, --tag

Tag the commit with an annotated tag. The tag name will be the raw version number preceeded with a “v”. Implies --commit.

-h, --help

You’re looking at it.

Example

Here a simple example using cat and here docs. When creating your package, you start off with a simple changelog:

$ cat << --- > Changelog.yaml
  unreleased:
    note: Initial release.
  ---

When you’re ready for a 1.0.0 release, just call yankee:

$ yankee
  1.0.0

$ cat Changelog.yaml
  1.0.0:
    date: 2016-05-20
    note: Initial release.

Working on new stuff, update the changelog accordingly:

$ cat << --- > Changelog.yaml
  unreleased:
    new features:
      - Cool new stuff!

  $(cat Changelog.yaml)
  ---

When ready for a release, yankee will figure out what the release number should be:

$ yankee
  1.1.0

$ cat Changelog.yaml
  1.1.0:
    date: 2016-05-20
    new features:
      - Cool new stuff!

  1.0.0:
    date: 2016-05-20
    note: Initial release.