{"bin":{"decorate-gh-pr":"cli.js"},"bugs":{"url":"https://github.com/Xiphe/decorate-gh-pr/issues"},"dist":{"shasum":"2f4e2f5d7c67e1f3debe607a4ac30c708657c1b4","tarball":"https://registry.npmjs.org/decorate-gh-pr/-/decorate-gh-pr-1.3.4-update-22.1659519140457.tgz","fileCount":11,"integrity":"sha512-Q6WBfms2+jy0uWa7+356wOs9nrRQZTDL3Ym1R8XQeLQwQL1wJb4+3zNGofDXmGMNSlqQjDw2Cn8RRSR1lF7aJg==","signatures":[{"sig":"MEYCIQCV7CJ3cMppXnLQ1+VntgsANk0H02dBkshDaRXTGx0oIAIhALXVld05qfp8LiMJSvk22mZSANBqFOPpDGyrswIh/aWP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13565,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi6kClACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpa7w/+LyET24FYIcMRgXmCLzbr76YH+N0tBCmqECaTygZ5Y6Z4mfVP\r\nycwI2JjO2Btx6dj5UsEfJKzW4nY+WnCy3HSPjTcWkHIH4UjkVxkPMHHdArBB\r\njMWlt4MFk7p5IrEbIK9MBPtyTsPPdtMmw5ZPVu2Xpai27kUm7r8qnJx2/0NE\r\nrWyQ1xVF7Ro+4YPvVZVdzqr17FT8EyEVN0c0qoUKHrqLTngOE0x24KcK7BxW\r\nupDxZsG0GasuRTteoRFfXqeQNO6qors/DWTihTTcU9VD80cAM45xjw8FesuQ\r\nxfJiTdLKOmvFnXdll7a1dbGlo050C3Yw2W9+e+GZ1O2thkFqIHaXIEPCcyjV\r\ncXCdKddjMnZZIGXev1Fza9hv5BEGwTXLAg7ihItHTQRqG7zoR03S4XNUSQEt\r\ntJRTLc31p6r/c0eAG8wFi7KKCUV/NkUErRc5Ojdeqvl0rqQ7HD9oMj5VaZ9D\r\nL1INCMwlKuxidsFUAnEdC3QK41kr2StZBNj7sV9bQ/rZ7ZSXg6p7oV8Mdw54\r\nG+Er21CxwagN2Ei4JK+HHMp68bt/6VuN8lnDSt99OJ+VkFUk+IYz5HA8bZPm\r\nfC++7KAsoS+GhWna0skWQZGJJ9oLEuQ3U2j/aMFgQ9yyeowgc4FYmFV4Rs75\r\nH5ioUBIb8HheD3vur/lceKmNLOoaDXtD2fA=\r\n=Cico\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":"79e85131cb92883f240a8e56c72392246dff9018","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":"8.15.1","description":"utility to add updatable comments to github pull requests","directories":{},"maintainers":[{"name":"xiphe","email":"npm@xiphe.net"}],"_nodeVersion":"16.13.1","dependencies":{"env-ci":"7.3.0","minimist":"1.2.6","@octokit/rest":"19.0.3","lodash.template":"4.5.0"},"_hasShrinkwrap":false,"readmeFilename":"readme.md","devDependencies":{"eslint":"8.21.0","prettier":"2.7.1","semantic-release":"19.0.3","eslint-plugin-import":"2.26.0","semantish-prerelease":"4.0.0","eslint-config-prettier":"8.5.0","eslint-plugin-prettier":"4.2.1","eslint-config-airbnb-base":"15.0.0"},"_npmOperationalInternal":{"tmp":"tmp/decorate-gh-pr_1.3.4-update-22.1659519140457_1659519141702_0.17515835407451052","host":"s3://npm-registry-packages"},"_id":"decorate-gh-pr@1.3.4-update-22.1659519140457","version":"1.3.4-update-22.1659519140457"}