{"bin":{"decorate-gh-pr":"cli.js"},"bugs":{"url":"https://github.com/Xiphe/decorate-gh-pr/issues"},"dist":{"shasum":"f685f497496a215fd9e35d73ef86159888b0d24c","tarball":"https://registry.npmjs.org/decorate-gh-pr/-/decorate-gh-pr-1.3.2-update-deps-21-04.c16d161.tgz","fileCount":13,"integrity":"sha512-B3cKUi3s6gbYFykHhJHFcqB3CaEc5W/lGmbkRlMjOwD2hv8UZR9DDkZcoEQPshuZVZGy2srYFHj5SgA0T1VptA==","signatures":[{"sig":"MEUCIQDprQaNUTX5gcbl/0K7qGbSi9AZAx5d/4QTELkkNlV7MgIgFairW+gp8uFzQ49dktDHG77vlrsKm4jBjQwXTVMVF18=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":12589,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgZqgbCRA9TVsSAnZWagAApQoP/0SXicxky4uaOWNm/zjj\ntSPlueB8gZTnACGUoa48n0FnlC7e6n40e8jMFZJVyxTOZhLDttnQqtfy5qIj\nXbhzVyhBmqr64vLwvSyQ1WRZ8xXl5nWCrN/axGZIspsXdQwZ6423BjcmSGYr\nS+A9S429LAUDFtykWW4ah2cJTUfX6bqL6sR8y3LHxQg94kuOoa94KoC1xgEq\nx95WTE9nxPk+rH06j4jg5vaUJiQCpKz2Vb3gpC2Ne1ScQl7TYzCwolklST8k\nbu4WA2keANNFmMQHDt3VsVBZyzKjJhGGFJuQKqHoxd6NCbIjJLYJYqN+QOhs\nhoayaWIRFifnhdY3q43FWClsj6WLaLJMp3/tZ3jPncPs/0/PIkhCw1fnhboJ\nWtu8h/uiDk9ZjMbs5LNMmmdttrWvJgr4sXgeMUlbIUXn6ywRjtucMR5LDQsh\nYo522EsQqVWckLrmI6v4lPY2FRBID0CugfTj0u5XjpCQl3V0/VlMRFvt2rxO\nioR4PqQhdftNME1MC8BGRkarQTDJ/XXQoSxxuGHPJrwp7gV9+MAufJwvOn2Y\ni8zhGFc6mudxyiPQN8HNgNiSKFyVugm2z49Zy7esjiOwaMag5drf64Je5nvV\nmnqMt+IVENWHJOTdsphRw3lbUy96PyolUiH0jZGiVDRpWeocrgXCHwcBvHv/\niXPS\r\n=2gYA\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":"c16d1613fa585d21fc2815f4e7bd427e8d5df0fd","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.8.0","description":"utility to add updatable comments to github pull requests","directories":{},"maintainers":[{"name":"xiphe","email":"npm@xiphe.net"}],"_nodeVersion":"12.22.0","dependencies":{"env-ci":"5.0.2","minimist":"1.2.5","@octokit/rest":"18.5.2","lodash.template":"4.5.0"},"_hasShrinkwrap":false,"readmeFilename":"readme.md","devDependencies":{"eslint":"7.23.0","prettier":"2.2.1","semantic-release":"17.4.2","eslint-plugin-import":"2.22.1","semantish-prerelease":"3.1.1","eslint-config-prettier":"8.1.0","eslint-plugin-prettier":"3.3.1","eslint-config-airbnb-base":"14.2.1"},"_npmOperationalInternal":{"tmp":"tmp/decorate-gh-pr_1.3.2-update-deps-21-04.c16d161_1617340443304_0.8846321581659866","host":"s3://npm-registry-packages"},"_id":"decorate-gh-pr@1.3.2-update-deps-21-04.c16d161","version":"1.3.2-update-deps-21-04.c16d161"}