{"_id":"@deja-js/generate-changelog","_rev":"7-c78161286d4ebfb751e170657ce46aa6","name":"@deja-js/generate-changelog","description":"Generate a changelog from git commits.","dist-tags":{"latest":"1.4.0"},"versions":{"1.3.1":{"name":"@deja-js/generate-changelog","version":"1.3.1","description":"Generate a changelog from git commits.","bugs":{"url":"https://github.com/DSI-HUG/generate-changelog/issues"},"author":{"name":"Team DSI-HUG - Hôpital Univesitaire de Genève - DSI - Domaine Patient"},"license":"Apache-2.0","bin":{"generate-changelog":"./bin/generate","changelog":"./bin/generate"},"main":"./lib/index.js","directories":{"test":"test"},"scripts":{"release:major":"./bin/generate -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major && git push origin && git push origin --tags","release:minor":"./bin/generate -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor && git push origin && git push origin --tags","release:patch":"./bin/generate -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags","coveralls":"cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js","lint":"eslint .","test":"NODE_ENV=test istanbul cover _mocha -- test --recursive --timeout 30000","test-no-cover":"NODE_ENV=test mocha test --recursive --timeout 30000"},"repository":{"type":"git","url":"git+https://github.com/DSI-HUG/generate-changelog.git"},"keywords":["changelog","cli","npm","version","git","semver"],"dependencies":{"bluebird":"^3.0.6","commander":"^2.9.0","github-url-from-git":"^1.4.0"},"devDependencies":{"chai":"^3.4.1","chai-as-promised":"^5.1.0","coveralls":"^2.11.6","eslint":"^1.10.3","eslint-config-lob":"1.0.x","istanbul":"^0.4.1","mocha":"^2.3.4","sinon":"^1.17.2"},"engine":{"node":">= 0.10.x"},"publishConfig":{"access":"public"},"gitHead":"069dd9c5c707c7a4ff8faae6b53d3e118b3b6685","homepage":"https://github.com/DSI-HUG/generate-changelog#readme","_id":"@deja-js/generate-changelog@1.3.1","_shasum":"e02620a2e0c2d41c036a5243cda6c2537a8cc90b","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.11.0","_npmUser":{"name":"deja-js","email":"gmer@hcuge.ch"},"dist":{"shasum":"e02620a2e0c2d41c036a5243cda6c2537a8cc90b","tarball":"https://registry.npmjs.org/@deja-js/generate-changelog/-/generate-changelog-1.3.1.tgz","integrity":"sha512-Q2nGzj7XoHaK6K7MmvhMVBs1/DklgLWMz5x25TQS1WzhSwkB/h8/3Q2WXSoLz1uXClpZ4Zyq+XXW8SupdmQSoA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDQq/Ot3HEnbsDterbEWmSwSmGGS3WXATHVMm06jufOmwIhAN+zlb5CfC5k7meazXU/NkvK4ovBxD2WbmsLLDPHSCVf"}]},"maintainers":[{"name":"deja-js","email":"gmer@hcuge.ch"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generate-changelog-1.3.1.tgz_1499100965546_0.9404370286501944"}},"1.4.0":{"name":"@deja-js/generate-changelog","version":"1.4.0","description":"Generate a changelog from git commits.","bugs":{"url":"https://github.com/DSI-HUG/generate-changelog/issues"},"author":{"name":"Team DSI-HUG - Hôpital Univesitaire de Genève - DSI - Domaine Patient"},"license":"Apache-2.0","bin":{"generate-changelog":"./bin/generate","changelog":"./bin/generate"},"main":"./lib/index.js","directories":{"test":"test"},"scripts":{"release:major":"./bin/generate -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major && git push origin && git push origin --tags","release:minor":"./bin/generate -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor && git push origin && git push origin --tags","release:patch":"./bin/generate -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags","coveralls":"cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js","lint":"eslint .","test":"NODE_ENV=test istanbul cover _mocha -- test --recursive --timeout 30000","test-no-cover":"NODE_ENV=test mocha test --recursive --timeout 30000"},"repository":{"type":"git","url":"git+https://github.com/DSI-HUG/generate-changelog.git"},"keywords":["changelog","cli","npm","version","git","semver"],"dependencies":{"bluebird":"^3.0.6","commander":"^2.9.0","github-url-from-git":"^1.4.0"},"devDependencies":{"chai":"^3.4.1","chai-as-promised":"^5.1.0","coveralls":"^2.11.6","eslint":"^1.10.3","eslint-config-lob":"1.0.x","istanbul":"^0.4.1","mocha":"^2.3.4","sinon":"^1.17.2"},"engine":{"node":">= 0.10.x"},"publishConfig":{"access":"public"},"gitHead":"e8b5152cbefd69417027ea9e17d73b061a0c360e","homepage":"https://github.com/DSI-HUG/generate-changelog#readme","_id":"@deja-js/generate-changelog@1.4.0","_shasum":"89ddf4df6cff3963ddee55b0aded578d4db3c709","_from":".","_npmVersion":"4.2.0","_nodeVersion":"7.10.1","_npmUser":{"name":"deja-js","email":"gmer@hcuge.ch"},"dist":{"shasum":"89ddf4df6cff3963ddee55b0aded578d4db3c709","tarball":"https://registry.npmjs.org/@deja-js/generate-changelog/-/generate-changelog-1.4.0.tgz","integrity":"sha512-twU6lafrNF4Mh9oVwFPxoA8CN+hW+2UGsX6heayweIyqISvQTRY5FMb8rWZ3Qm36HdA/ctc/raW6KmyFWk/JHQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC0u7uTDJzUnCbWV6E+3OC3jbdodQffMLJL2KQJFs9UbwIgTEX+4PPeUg3qhXq6jBcQ20EN4URoBDMXFe6OHjX2zds="}]},"maintainers":[{"name":"deja-js","email":"gmer@hcuge.ch"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generate-changelog-1.4.0.tgz_1508182440287_0.8598635189700872"}}},"readme":"# Generate Changelog\n\n[![NPM Version](https://badge.fury.io/js/generate-changelog.svg)](https://www.npmjs.com/package/generate-changelog)\n[![Build Status](https://travis-ci.org/lob/generate-changelog.svg)](https://travis-ci.org/lob/generate-changelog)\n[![Coverage Status](https://coveralls.io/repos/lob/generate-changelog/badge.svg?branch=master&service=github)](https://coveralls.io/github/lob/generate-changelog?branch=master)\n[![Dependency Status](https://david-dm.org/lob/generate-changelog.svg)](https://david-dm.org/lob/generate-changelog)\n\nGenerate a changelog from git commits. This is meant to be used so that for every patch, minor, or major version, you update the changelog _prior_ to running `npm version` so that the git tag contains the commit that updated both the changelog and version.\n\n## Installation\n\nYou can either install it as a dev dependency to be referenced in your npm scripts, or you can install this module globally to be used for all of your repos on your local machine.\n\n```bash\n$ npm i generate-changelog -D # install it as a dev dependency\n# OR\n$ npm i generate-changelog -g # install it globally\n```\n\n## Usage\n\nTo use this module, your commit messages have to be in this format:\n\n```\ntype(category): description\n```\n\nWhere `type` is one of the following:\n\n* `build`\n* `ci`\n* `chore`\n* `docs`\n* `feat`\n* `fix`\n* `other`\n* `perf`\n* `refactor`\n* `revert`\n* `style`\n* `test`\n\nAnd `category` can be anything of your choice. If you use a type not found in the list (but it still follows the same format of the message), it'll be grouped under `other`.\n\nYou can either run this module as a CLI app that prepends the new logs to a file (recommended):\n\n```bash\n$ changelog -h\n\n  Usage: generate [options]\n\n  Generate a changelog from git commits.\n\n  Options:\n\n    -h, --help            output usage information\n    -V, --version         output the version number\n    -p, --patch           create a patch changelog\n    -m, --minor           create a minor changelog\n    -M, --major           create a major changelog\n    -x, --exclude         exclude selected commit types (comma separated)\n    -f, --file [file]     file to write to, defaults to ./CHANGELOG.md, use - for stdout\n    -u, --repo-url [url]  specify the repo URL for commit links, defaults to checking the package.json\n\n```\n\nOr you can write a script that calls the `generate` function and does whatever you want with the new logs:\n\n```js\nvar Changelog = require('generate-changelog');\nvar Fs        = require('fs');\n\nreturn Changelog.generate({ patch: true, repoUrl: 'https://github.com/lob/generate-changelog' })\n.then(function (changelog) {\n  Fs.writeFileSync('./CHANGELOG.md', changelog);\n});\n```\n\n### Recommended\n\nThe way that I would recommend using this module would be the way it's being used in this module: as npm scripts. You should install it as a dev dependency and then add the following to the `scripts` object in your `package.json`:\n\n```json\n\"release:major\": \"changelog -M && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major && git push origin && git push origin --tags\",\n\"release:minor\": \"changelog -m && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor && git push origin && git push origin --tags\",\n\"release:patch\": \"changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags\",\n```\n\n## Testing\n\nTo run the test suite, just clone the repository and run the following:\n\n```bash\n$ npm i\n$ npm test\n```\n\n## Contributing\n\nTo contribute, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.\n\n## License\n\nThis project is released under the Apache 2 license, which can be found in [`LICENSE.txt`](LICENSE.txt).\n","maintainers":[{"email":"maxf@hcuge.ch","name":"x2js"},{"email":"dsi-hug-npm@hcuge.ch","name":"dsi-hug"}],"time":{"modified":"2022-10-24T13:43:16.394Z","created":"2017-07-03T16:56:06.606Z","1.3.1":"2017-07-03T16:56:06.606Z","1.4.0":"2017-10-16T19:34:01.339Z"},"homepage":"https://github.com/DSI-HUG/generate-changelog#readme","keywords":["changelog","cli","npm","version","git","semver"],"repository":{"type":"git","url":"git+https://github.com/DSI-HUG/generate-changelog.git"},"author":{"name":"Team DSI-HUG - Hôpital Univesitaire de Genève - DSI - Domaine Patient"},"bugs":{"url":"https://github.com/DSI-HUG/generate-changelog/issues"},"license":"Apache-2.0","readmeFilename":"README.md"}