{"bin":{"decorate-gh-pr":"cli.js"},"bugs":{"url":"https://github.com/Xiphe/decorate-gh-pr/issues"},"dist":{"shasum":"94c14204bfef1a398f76622641bb9a80c18d1a26","tarball":"https://registry.npmjs.org/decorate-gh-pr/-/decorate-gh-pr-1.3.3-update-deps-21-08.93eff05.tgz","fileCount":11,"integrity":"sha512-Yz0PvicexVJmQuqvKKH+xtbXPpcgEXuRtb8EyHir2iWxC4Wmefng2HCi59oPmdveoUhd7x9eYQFoS/XskyRFSg==","signatures":[{"sig":"MEYCIQD90ByjVFK9262NV1ar37xb9pngEjwRj+RpH/fkfrdKKQIhAKN/5zij88D4PINmR6z/+LI+219ylNXBHZEs+t4Shx/r","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":12768,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhk+YkCRA9TVsSAnZWagAADpsP/3v8RAc0CUEPG73esPH8\nwj6+DQ+TJeN460uQNd0B1unoXX1GhhzCiebO0I7EA2TJMDW/r3ko6SpeSpKk\nil9mKboyShCIPJ8yh483TZKQFctuglIdcptcz9rtJAEpV/a+lequOfeEgQqG\nIzL329K6dTXHWUSiOA64h0eB5zPAaW2Mg+irfmTs4LJH8bXSoL7bdWZ4pze8\n8UlfsJmszqEtntgvTbA3hcT/V4kfLot4vTWMXKexY9WkKqwk02y7N1o6kwG3\nAA53+l0yP9vrw6BqYM1oaegm4mEQn9zWLcyJTYVQy1Tst/xDAsFmNwThqIjt\nU6mwoMec7x6ubaNpUMzBEaFfoQGvjOWEfOLLffQhmxop/GOUDx2ROFZoDa0H\nnyiqTNct7trVdd0lNcAEve9nQatMNaBhMEq0gi2aUAPZw0Eh/8otl35YEvpD\n0/XQOXHnd+tWZi9yG5JCX5UyGNXop9RsTrFVH6sjdl8iIsYzdXBwLKxOoTjT\nALi134TLDaxtzf0pF8LD6/hRC0aWz9mrzj+T13y68oWet6bJ/3hfQRH6GpKO\nGfwaCaEQsQmWLj4FACKh5TvSOEqopG764B3SMQYfIngWLb2cUQgNfgsgmC5H\noQo+D7WGKM3a4YyLaiQ6YiSpmBLAV7TayHMz3BuaiL1+SppxAf5XYleIE+el\nYxtt\r\n=ijXm\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","name":"decorate-gh-pr","author":{"url":"https://xiphe.net/","name":"Hannes Diercks","email":"node@xiphe.net"},"readme":"# decorate-gh-pr\n\n[![CircleCI Status](https://circleci.com/gh/Xiphe/decorate-gh-pr/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/Xiphe/decorate-gh-pr?branch=main) \n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![semantish-prerelease](https://img.shields.io/badge/%F0%9F%93%A6%F0%9F%9B%B8-semantish--prerelease-d86b86.svg)](https://github.com/Xiphe/semantish-prerelease)\n\n\nappend updatable text to the description of a pull request on GitHub.\n\n## Usage\n\nAll usages require a `GITHUB_TOKEN` or `GH_TOKEN` environment variable with write access to the PR.\n\nWhen invoked multiple times with same `id` the previous text will be overwritten.\n\n### CLI\n\n`npx decorate-gh-pr -h`\n\n```bash\ndecorate-gh-pr [flags]\n\ndecorate a GitHub Pull request\n\nOptions:\n\n  -f, --file     JavaScript file producing a Promise resolving to comment\n  -c, --comment  The comment\n  -r, --prepend  (Optional) Prepend new comments to the PR body\n                 Default: false - comment is appended at the end\n  -m, --compact  (Optional) Minimize added new-lines and whitespace\n                 Default: false - new comments are added in a new line\n  -i, --id       (Optional) Custom Identifier for the comment\n                 Default: \"decorate-gh-pr\"\n  -p, --pr       (Optional) PR identifier. Example: Xiphe/decorate-gh-pr#1\n                 Default: CI environment from env-ci package\n  -h, --help     Print this message\n```\n\n### Lib\n\n`npm install decorate-gh-pr`\n\n```js\nconst decorateGhPr = require(' decorate-gh-pr');\nconst envCi = require('env-ci');\n\ndecorateGhPr({\n  comment: 'Hello PR',\n  /* OPTIONAL: */\n  id: 'decorate-gh-pr',\n  prepend: false,\n  env: envCi(),\n  compact: false,\n}).catch((err) => { /* handle error */ })\n```\n\n### With semantic-release\n\n`npm install decorate-gh-pr`\n\n```js\n// release.config.js\nmodule.exports = {\n  plugins: [\n    [\n      \"decorate-gh-pr/on-release\",\n      {\n        /* uses https://lodash.com/docs/4.17.15#template */\n        comment: 'Hello <%= version %> on <% print(date.toISOString()) %>'\n        /* OPTIONAL: */\n        compact: false,\n        prepend: false,\n        id: 'decorate-gh-pr',\n      }\n    ],\n  ]\n};\n```\n\n## License\n\n> The MIT License\n>\n> Copyright (C) 2021 Hannes Diercks\n>\n> Permission is hereby granted, free of charge, to any person obtaining a copy of\n> this software and associated documentation files (the \"Software\"), to deal in\n> the Software without restriction, including without limitation the rights to\n> use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n> of the Software, and to permit persons to whom the Software is furnished to do\n> so, subject to the following conditions:\n>\n> The above copyright notice and this permission notice shall be included in all\n> copies or substantial portions of the Software.\n>\n> THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n> FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\n> COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\n> IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n> CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","gitHead":"93eff05de7cd959ca9bdae3978b4fea95b71d4b6","license":"MIT","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"xiphe","email":"npm@xiphe.net"},"homepage":"https://github.com/Xiphe/decorate-gh-pr#readme","keywords":["github","pull-request","update","notify","decorate","comment"],"repository":{"url":"git+https://github.com/Xiphe/decorate-gh-pr.git","type":"git"},"_npmVersion":"7.24.2","description":"utility to add updatable comments to github pull requests","directories":{},"maintainers":[{"name":"xiphe","email":"npm@xiphe.net"}],"_nodeVersion":"16.13.0","dependencies":{"env-ci":"5.4.1","minimist":"1.2.5","@octokit/rest":"18.12.0","lodash.template":"4.5.0"},"_hasShrinkwrap":false,"readmeFilename":"readme.md","_npmOperationalInternal":{"tmp":"tmp/decorate-gh-pr_1.3.3-update-deps-21-08.93eff05_1637082660166_0.982115704238228","host":"s3://npm-registry-packages"},"_id":"decorate-gh-pr@1.3.3-update-deps-21-08.93eff05","version":"1.3.3-update-deps-21-08.93eff05"}