{"_id":"@agilgur5/changelog-maker","_rev":"1-5129fe34deea5595ecaee148f5f72f36","name":"@agilgur5/changelog-maker","dist-tags":{"latest":"3.0.0"},"versions":{"3.0.0":{"name":"@agilgur5/changelog-maker","version":"3.0.0","description":"A git log to release changelog tool","main":"changelog-maker.js","bin":{"changelog-maker":"./changelog-maker.js"},"preferGlobal":true,"author":{"name":"Anton Gilgur"},"license":"Apache-2.0","homepage":"https://github.com/agilgur5/changelog-maker","repository":{"type":"git","url":"git+https://github.com/agilgur5/changelog-maker.git"},"bugs":{"url":"https://github.com/agilgur5/changelog-maker/issues"},"keywords":["changelog","generate","convention","commit","log","release","tag","history","git","github"],"scripts":{"lint":"standard","test":"standard && tape test.js"},"dependencies":{"async":"~2.6.1","chalk":"~2.4.1","commit-stream":"~1.1.0","debug":"~4.1.0","ghauth":"~3.2.1","ghissues":"~1.1.3","gitexec":"~1.0.0","list-stream":"~1.0.1","minimist":"~1.2.0","pkg-to-id":"~0.0.3","split2":"~3.0.0","strip-ansi":"~5.0.0"},"devDependencies":{"standard":"~12.0.1","tape":"~4.9.1"},"gitHead":"76acac8e8c1745f62c8bf2bf42d1dcb031260321","_id":"@agilgur5/changelog-maker@3.0.0","_nodeVersion":"10.16.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-UYAxHEsedy21bZw/xzMc6yt4Q8uashoTsbTm+seUJGyXyIalshtIzbLikoYJoChC6JwaYyeLXWnKN3KpBBV/gQ==","shasum":"3585ff33160a64d68b7097971b2d77e3373c4992","tarball":"https://registry.npmjs.org/@agilgur5/changelog-maker/-/changelog-maker-3.0.0.tgz","fileCount":10,"unpackedSize":20455,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdNpKKCRA9TVsSAnZWagAAqr4P/0M2sewmiyQuyjACiuQ8\nqMvx50O0L9n7n+Te1kfwANJl7CAySN+6miasj4DLL53Dru1KqPkIaB/24eXx\nABB0st1oUy5Zd6xKxcuMRrO9vTmO9ROZ/C7RLd8PCwDepWw/HAVd1t3GSTRw\nDzezJr8ZKdQCCIQHiVRtR7vavXvxFShvPyb+2afMgPhRFMwAMp1QoaXIdH1M\ne8k4ixGtFjLWQ6WEvoh3/fcwjvwUT+etAIJwPWA7A4v4EwIB2JPtVtm1H9tP\n3LRwCHtim5oidu7w/DWt/qQmVO9TEGkj9j8ebplgj42b7hpNFL03K9/hBtTx\nkCPSDON/19XY1ihAPyyH8XclYI2TDGJ22S6l0VIVSO2Pa7pnoexR0D3xsZv3\neVSAk5wwinG3FmrRC8YKTas8BkWW3GdkpSbfCzSUlH4bjAz/J7IaNIgEMpM5\nLeetaCQs+qh6hkjPzJMchNkrQT6m4v4qEMsUEN1AvZiz3rXcQAO6yFWtte63\nLvxN0IbAgzu8uYLGpwf1ceEpwJ03q1QVcNjKOhRTaOQwG7pmYoCfJtkuzqrz\n+uh95yj782XMzMPajXrmFup3lN+8SECm5tZXKfSKGzp4oxcT14N3tlYbD2fg\nYz2rrZ0Pt+14MD5M5G4Tsq5LMb29b4uuHxityI6u5Pea7oCkZ4N8sLsyz3zq\nKJB9\r\n=O8mc\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC/qIG0Yc6cT4rt6jlO3I3PygIAnNBL3YWIGcovhoB1iQIhALaA5ciKHinlqkiq7siRnZIVjSxREOyh4GyjNz7giknC"}]},"maintainers":[{"name":"agilgur5","email":"agilgur5@gmail.com"}],"_npmUser":{"name":"agilgur5","email":"agilgur5@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/changelog-maker_3.0.0_1563857545490_0.49287847776669813"},"_hasShrinkwrap":false}},"time":{"created":"2019-07-23T04:52:25.289Z","3.0.0":"2019-07-23T04:52:25.615Z","modified":"2022-04-04T11:59:26.262Z"},"maintainers":[{"name":"agilgur5","email":"agilgur5@gmail.com"}],"description":"A git log to release changelog tool","homepage":"https://github.com/agilgur5/changelog-maker","keywords":["changelog","generate","convention","commit","log","release","tag","history","git","github"],"repository":{"type":"git","url":"git+https://github.com/agilgur5/changelog-maker.git"},"author":{"name":"Anton Gilgur"},"bugs":{"url":"https://github.com/agilgur5/changelog-maker/issues"},"license":"Apache-2.0","readme":"# @agilgur5/changelog-maker\n\n**A git log to release changelog tool**\n\n<!-- releases / versioning -->\n[![package-json](https://img.shields.io/github/package-json/v/agilgur5/changelog-maker.svg)](https://npmjs.org/package/changelog-maker)\n[![releases](https://img.shields.io/github/release/agilgur5/changelog-maker.svg)](https://github.com/agilgur5/changelog-maker/releases)\n[![commits](https://img.shields.io/github/commits-since/agilgur5/changelog-maker/latest.svg)](https://github.com/agilgur5/changelog-maker/commits/master)\n<br><!-- downloads -->\n[![dt](https://img.shields.io/npm/dt/@agilgur5/changelog-maker.svg)](https://npmjs.org/package/@agilgur5/changelog-maker)\n[![dy](https://img.shields.io/npm/dy/@agilgur5/changelog-maker.svg)](https://npmjs.org/package/@agilgur5/changelog-maker)\n[![dm](https://img.shields.io/npm/dm/@agilgur5/changelog-maker.svg)](https://npmjs.org/package/@agilgur5/changelog-maker)\n[![dw](https://img.shields.io/npm/dw/@agilgur5/changelog-maker.svg)](https://npmjs.org/package/@agilgur5/changelog-maker)\n<br>\n[![NPM](https://nodei.co/npm/@agilgur5/changelog-maker.png?downloads=true&downloadRank=true&stars=true)](https://npmjs.org/package/@agilgur5/changelog-maker)\n\n## Eh?\n\n**@agilgur5/changelog-maker** is a slightly modified version of [Node's `changelog-maker`](https://github.com/nodejs/changelog-maker).\nAlong with the changelog described below, this version will add some Markdown around it as well, looking like:\n\n````markdown\n## Release\n\n```\n...latest tag's commit message goes here...\n```\n\n## Changelog\n\n...changelog goes here...\n\n[v1.0.1...v1.0.2](https://github.com/agilgur5/repo/compare/v1.0.1...v1.0.2)\n````\n\n**changelog-maker** will look at the git log of the current directory, pulling entries since the last tag. Commits with just a version number in the summary are removed, as are commits prior to, and including summaries that say `working on <version>` (this is an io.js / Node ism).\n\nAfter collecting the list of commits, any that have `PR-URL: <url>` in them are looked up on GitHub and the labels of the pull request are collected, specifically looking for labels that start with `semver` (the assumption is that `semver-minor`, `semver-major` labels are used to indicate non-patch version bumps).\n\nFinally, the list is formatted as Markdown and printed to stdout.\n\nEach commit will come out something like this (on one line):\n\n```\n* [[`20f8e7f17a`](https://github.com/nodejs/io.js/commit/20f8e7f17a)] -\n  **test**: remove flaky test functionality (Rod Vagg)\n  [#812](https://github.com/nodejs/io.js/pull/812)\n```\n\nNote:\n\n* When running `changelog-maker` on the command-line, the default GitHub repo is computed from the `package.json` that exists on `cwd`, otherwise fallback to `nodejs/node`, you can change this by supplying the user/org as the first argument and project as the second. e.g `changelog-maker joyent node`.\n* Commit links will go to the assumed repo (default: nodejs/node)\n* If a commit summary starts with a word, followed by a `:`, this is treated as a special label and rendered in bold\n* Commits that have `semver*` labels on the pull request referred to in their `PR-URL` have those labels printed out at the start of the summary, in bold, upper cased.\n* Pull request URLs come from the `PR-URL` data, if it matches the assumed repo (default: nodejs/node) then just a `#` followed by the number, if another repo then a full `user/project#number`.\n\nWhen printing to a console some special behaviours are invoked:\n\n* Commits with a summary that starts with `doc:` are rendered in grey\n* Commits that have a `semver*` label on the pull request referred to in their `PR-URL` are rendered in bold green\n\n## Install\n\n```\n$ npm i @agilgur5/changelog-maker -g\n```\n\n## Usage\n\n**`changelog-maker [--simple] [--group] [--commit-url=<url/with/{ref}>] [--start-ref=<ref>] [--end-ref=<ref>] [github-user[, github-project]]`**\n\n`github-user` and `github-project` should point to the GitHub repository that can be used to find the `PR-URL` data if just an issue number is provided and will also impact how the PR-URL issue numbers are displayed\n\n * `--simple`:          print a simple form, without additional Markdown cruft\n * `--group`:           reorder commits so that they are listed in groups where the `xyz:` prefix of the commit message defines the group. Commits are listed in original order _within_ group.\n * `--commit-url`:      pass in a url template which will be used to generate commit URLs for a repository not hosted in Github. `{ref}` is the placeholder that will be replaced with the commit, i.e. `--commit-url=https://gitlab.com/myUser/myRepo/commit/{ref}`\n * `--start-ref=<ref>`: use the given git `<ref>` as a starting point rather than the _second-to-last tag_. The `<ref>` can be anything commit-ish including a commit sha, tag, branch name. If you specify a `--start-ref` argument the commit log will not be pruned so that version commits and `working on <version>` commits are left in the list.\n * `--end-ref=<ref>`:   use the given git `<ref>` as a end-point rather than the _last tag_. The `<ref>` can be anything commit-ish including a commit sha, tag, branch name.\n * `--filter-release`:  exclude Node-style release commits from the list. e.g. \"Working on v1.0.0\" or \"2015-10-21 Version 2.0.0\" and also \"npm version X\" style commits containing _only_ an `x.y.z` semver designator.\n * `--quiet` or `-q`:   do not print to `process.stdout`\n * `--all` or `-a`:     process all commits since beginning, instead of last tag.\n * `--help` or `-h`:    show usage and help.\n\nPlease note that the defaults for `--start-ref` and `--end-ref` have changed slightly between `@agilgur5/changelog-maker` and the original `changelog-maker`.\n`changelog-maker` used \"last tag\" and \"now\" whereas `@agilgur5/changelog-maker` uses \"second-to-last tag\" and \"last tag\".\n","readmeFilename":"README.md"}