{"_id":"@dougkulak/semantic-release-gh-pages-plugin","_rev":"1-bba6745b1417599d5b738d3b1f362575","name":"@dougkulak/semantic-release-gh-pages-plugin","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dougkulak/semantic-release-gh-pages-plugin","version":"1.0.0","private":false,"publishConfig":{"access":"public"},"description":"gh-pages publishing plugin for semantic-release","keywords":["gh-pages","ghpages","github pages","semantic-release","semantic release"],"main":"target/es5/index.js","types":"typings/index.d.ts","typescript":{"definition":"typings/index.d.ts"},"scripts":{"clean":"rimraf target flow-typed typings docs coverage","lint":"eslint src/**/*.ts","lint:fix":"yarn lint --fix","test":"npm-run-all -p -l lint test:unit test:depcheck","test:unit":"jest --config=jest.config.json --detectOpenHandles --forceExit","test:deps":"npm-run-all -p -l test:depcheck test:depaudit","test:depcheck":"npx depcheck --ignores tslib,@swissquote/crafty-preset-jest,@types/jest,semantic-release","test:depaudit":"exit 0 || yarn audit --level moderate","test:depauditfix":"npx yarn-audit-fix","test:report":"yarn test && yarn coveralls:push","build":"yarn clean && npm-run-all -p -l build:es5 build:es6 build:ts build:libdef docs","build:es5":"mkdirp target/es5 && tsc -p tsconfig.es5.json","build:es6":"mkdirp target/es6 && tsc -p tsconfig.es6.json","build:ts":"cpy src/main/ts/ target/ts/","build:libdef":"libdefkit --tsconfig=tsconfig.es5.json --tsconfig=tsconfig.es6.json","coveralls:push":"cat ./coverage/lcov.info | coveralls || exit 0","docs":"typedoc src/main/ts","postupdate":"yarn && yarn test:deps && yarn build && yarn test","publish:beta":"npm publish --no-git-tag-version --tag beta"},"dependencies":{"@types/debug":"^4.1.6","@types/git-url-parse":"^9.0.0","@types/semantic-release":"^17.2.0","@types/gh-pages":"^3.0.0","@types/lodash":"^4.14.170","@qiwi/substrate":"^1.20.9","aggregate-error":"^3.1.0","debug":"^4.3.2","execa":"^5.1.1","gh-pages":"^3.2.3","git-url-parse":"^11.5.0","lodash":"^4.17.21","queuefy":"^1.1.5","read-pkg":"^5.2.0","then-request":"^6.0.2","tslib":"^2.3.0"},"devDependencies":{"@qiwi/libdefkit":"3.1.1","@qiwi/npm-run-all":"^4.1.7","@types/jest":"^27.0.0","coveralls":"^3.1.1","jest":"^27.0.0","cpy-cli":"^3.1.1","mkdirp":"^1.0.4","rimraf":"^3.0.2","ts-jest":"^27.0.0","eslint":"^7.30.0","eslint-config-prettier":"^8.3.0","eslint-config-dougkulak":"^1.0.0","typedoc":"^0.21.2","typescript":"4.3.5"},"repository":{"type":"git","url":"git+https://github.com/dougkulak/semantic-release-gh-pages-plugin.git"},"bugs":{"url":"https://github.com/dougkulak/semantic-release-gh-pages-plugin/issues"},"author":{"name":"Doug Kulak","email":"dougkulak@gmail.com"},"license":"MIT","gitHead":"ef12e09698d5724b12ff1cc95ccf4a8522bc5c0a","homepage":"https://github.com/dougkulak/semantic-release-gh-pages-plugin#readme","_id":"@dougkulak/semantic-release-gh-pages-plugin@1.0.0","_nodeVersion":"14.17.5","_npmVersion":"6.14.14","dist":{"integrity":"sha512-sau0MIdgZcDKHMGvmOadDtxiuaezBed+eNNcnRKJ208fR/kaec2sEco5ZEvpvDqu8HzF/+dpz5RWR/q5glS2rA==","shasum":"e2a9e1876340d5149ba931998428bfc1d0293c28","tarball":"https://registry.npmjs.org/@dougkulak/semantic-release-gh-pages-plugin/-/semantic-release-gh-pages-plugin-1.0.0.tgz","fileCount":27,"unpackedSize":54170,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhI8vrCRA9TVsSAnZWagAA9VUP/09WMONoK/z93n3IdBB1\n4LX6uWvJZIAQiOUkKlew1Zsax/xMz/11Fq2PH2jn+ZrFRZtPgqeRTlTWkjFB\nkcbaXxJ1fKkWj561wISqnhpo4GSW7MxcHxO0q3qw9c59J4hAb5Dab+3cfaWz\nSHSQiPuguwJbLvRxJ/zksHMm+CHaUgba9V55kPrKvmC+OWkiNaldHo3P7aQV\n4FAj/7BgVYxYw2XrYDc/YTjnsmJnqd39IxMzG1/vPS4AJ7JIJ3JIClJ1FZSF\nJqPB61rpSgU5rds5U2baN3/Kc5b/LA7MDkC+bkkRvyYRwAMjyLlzZO6ExSGv\nOhBzZ7DP8Ov8UTCFfKJdYemeCLXecHmn6iubTTqhBvi37kb3Q8R6fzxsr8/6\n6AEGU7PBHYp0ZmJt9Fw8WTvjFJ1UkSnzjCW6S/xcdFEzFDO650SWJdrGrKnw\nmLLTyzqfvckSIBv7mVE0T0DDuASSvNUpZ4wTJ14pXXhAtnmpDbv+ymvr0gij\nlTf9g+YtTAjb9QlyA1iLIZb5V+omPGTruxXw40sbDXtnpvcG35mDrVJx6ara\nDwYVCyecraV7TV+exaZScCqw27Pv33LGx7injyTx6FbBRlE1dgZTrf1agVsh\nKHqcFKAjASfdot950kIspulWxQLYz8DKGJAorUjsWE2xRaUA5U0Mlt6QWiqc\nnlr6\r\n=xl1Z\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDT+/f+IMNQBFbllMxPu4FGSLm6lMuu1b2ET+/Ij2ZPfAIhAK8EXYk4WKHmq3Er9Z901ymL68QHVcx9YMirhFWWYLxi"}]},"_npmUser":{"name":"dougkulak","email":"doug.kulak@gmail.com"},"directories":{},"maintainers":[{"name":"dougkulak","email":"doug.kulak@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-gh-pages-plugin_1.0.0_1629735915245_0.6793334754338687"},"_hasShrinkwrap":false}},"time":{"created":"2021-08-23T16:25:15.183Z","1.0.0":"2021-08-23T16:25:15.379Z","modified":"2022-04-05T05:30:27.207Z"},"maintainers":[{"name":"dougkulak","email":"doug.kulak@gmail.com"}],"description":"gh-pages publishing plugin for semantic-release","homepage":"https://github.com/dougkulak/semantic-release-gh-pages-plugin#readme","keywords":["gh-pages","ghpages","github pages","semantic-release","semantic release"],"repository":{"type":"git","url":"git+https://github.com/dougkulak/semantic-release-gh-pages-plugin.git"},"author":{"name":"Doug Kulak","email":"dougkulak@gmail.com"},"bugs":{"url":"https://github.com/dougkulak/semantic-release-gh-pages-plugin/issues"},"license":"MIT","readme":"# @dougkulak/semantic-release-gh-pages-plugin\n\n[](https://travis-ci.com/dougkulak/semantic-release-gh-pages-plugin)\n[](https://david-dm.org/dougkulak/semantic-release-gh-pages-plugin)\n[](https://codeclimate.com/github/dougkulak/semantic-release-gh-pages-plugin/test_coverage)\n[](https://codeclimate.com/github/dougkulak/semantic-release-gh-pages-plugin/maintainability)\n[](https://github.com/dougkulak/lint-config-dougkulak)\n[](https://www.npmjs.com/package/@dougkulak/semantic-release-gh-pages-plugin)\n\ngh-pages publishing plugin for [semantic-release](https://github.com/semantic-release/semantic-release)\n\n| Step | Description |\n|--------------------|-------------|\n| `verifyConditions` | Verify the presence of the `GH_TOKEN` set via [environment variables](#environment-variables). |\n| `publish` | Pushes commit to the [documentation branch](#options) |\n\n### Install\n```bash\nyarn add @dougkulak/semantic-release-gh-pages-plugin --dev\n```\nor\n```bash\nnpm add @dougkulak/semantic-release-gh-pages-plugin -D\n```\n\n### Usage\n\nDescribe plugin configuration in [package.json / .releaserc.js](https://github.com/semantic-release/semantic-release/blob/master/docs/01-usage/plugins.md#plugins-configuration-options)\n```json\n{\n \"release\": {\n \"branch\": \"master\",\n \"verifyConditions\": [\n \"@semantic-release/changelog\",\n \"@semantic-release/npm\",\n \"@semantic-release/git\",\n \"@dougkulak/semantic-release-gh-pages-plugin\"\n ],\n \"publish\": [\n \"@semantic-release/npm\",\n \"@semantic-release/github\",\n [\n \"@dougkulak/semantic-release-gh-pages-plugin\",\n {\n \"msg\": \"updated\",\n \"branch\": \"docs\"\n }\n ]\n ]\n }\n}\n```\nor even shorter if default settings are used:\n```json\n{\n \"release\": {\n \"branch\": \"master\",\n \"plugins\": [\n \"@semantic-release/release-notes-generator\",\n \"@semantic-release/changelog\",\n \"@semantic-release/git\",\n \"@semantic-release/github\",\n \"@semantic-release/npm\",\n \"@dougkulak/semantic-release-gh-pages-plugin\"\n ]\n }\n}\n```\n\n### Configuration\n##### Environment variables\n\n| Variable | Description |\n|------------------------------| --------------------------------------------------------- |\n| `GH_TOKEN` or `GITHUB_TOKEN` | **Required.** The token used to authenticate with GitHub. |\n\n##### Options\n\n| Option | Description | Default |\n|-----------------|---------------------------------------------------------| --------|\n| `msg` | Commit message template | `docs updated <%= nextRelease.gitTag %>` |\n| `src` | Documentation directory | `docs`
**NOTE** don't forget to run docs builder (`yarn docs`, `yarn typedoc`, etc) as a part of your build step or any other way|\n| `dst` | Destination directory | `.` (root) |\n| `branch` | Docs branch to push | `gh-pages` |\n| `repositoryUrl` | Repository url | inherited from .git |\n| `enterprise` | Disables host assertion for GitHub Enterprise domains | false |\n| `pullTagsBranch`| Target branch for tags fetching hook. If '' empty string, skips this action | `globalConfig.branch` \\|\\| `master` |\n| `dotfiles`| gh-pages [dotfiles](https://github.com/tschaub/gh-pages#optionsdotfiles) option | `false` |\n| `add`| gh-pages [add](https://github.com/tschaub/gh-pages#optionsadd) option | `false` |\n","readmeFilename":"README.md"}