{"_id":"@dvirtz/semantic-release-gh-pages-plugin","_rev":"1-12b1750932e2083b67aa9d98e49d319a","name":"@dvirtz/semantic-release-gh-pages-plugin","dist-tags":{"latest":"5.2.13"},"versions":{"5.2.12":{"name":"@dvirtz/semantic-release-gh-pages-plugin","version":"5.2.12","keywords":["gh-pages","ghpages","github pages","semantic-release","semantic release"],"author":{"name":"Anton Golub","email":"mailbox@antongolub.ru"},"license":"MIT","_id":"@dvirtz/semantic-release-gh-pages-plugin@5.2.12","maintainers":[{"name":"dvirtz","email":"dvirtz@gmail.com"}],"bugs":{"url":"https://github.com/dvirtz/semantic-release-gh-pages-plugin/issues"},"dist":{"shasum":"53ec077120489c88706a3c420351c3c1ca3d3a44","tarball":"https://registry.npmjs.org/@dvirtz/semantic-release-gh-pages-plugin/-/semantic-release-gh-pages-plugin-5.2.12.tgz","fileCount":30,"integrity":"sha512-UkUDaxbPqVJmaHyV8HwsNw5yK0GwiFnIzr1ozjOQ3qcZ+lZsglHZ9am8Whydv/cQ+JNuANOeFJ+RCsmKfI99kg==","signatures":[{"sig":"MEUCIHzd4RAmPdn8EaNQ63zVzN+duawulwFk3MgOLDFro2eKAiEAqp/XVbrttFFDyk59W7hPUitzK1jJ3gCEwU+e+4beP2U=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":94103},"main":"target/es5/index.js","types":"typings/index.d.ts","private":false,"scripts":{"docs":"typedoc src/main/ts","lint":"eslint src/**/*.ts","test":"npm-run-all -p -l lint test:unit test:depcheck","build":"yarn clean && npm-run-all -p -l build:es5 build:es6 build:ts build:libdef docs","clean":"rimraf target flow-typed typings docs coverage","build:ts":"cpy src/main/ts/ target/ts/ --flat","lint:fix":"yarn lint --fix","build:es5":"mkdirp target/es5 && tsc -p tsconfig.es5.json","build:es6":"mkdirp target/es6 && tsc -p tsconfig.es6.json","test:deps":"npm-run-all -p -l test:depcheck test:depaudit","test:unit":"jest --config=jest.config.json --detectOpenHandles --forceExit","postupdate":"yarn && npm_config_yes=true npx yarn-audit-fix && yarn test:deps && yarn build && yarn test","build:libdef":"libdefkit --tsconfig=tsconfig.es5.json --tsconfig=tsconfig.es6.json","publish:beta":"npm publish --no-git-tag-version --tag beta","test:depaudit":"yarn audit --level=moderate --groups=dependencies; [[ $? -ge 4 ]] && exit 1 || exit 0","test:depcheck":"npx depcheck --ignores rimraf,mkdirp,typedoc,tslib,@swissquote/crafty-preset-jest,@types/jest,semantic-release","test:depauditfix":"npm_config_yes=true npx yarn-audit-fix --audit-level=moderate"},"_npmUser":{"name":"dvirtz","email":"dvirtz@gmail.com"},"repository":{"url":"https://github.com/dvirtz/semantic-release-gh-pages-plugin.git","type":"git"},"typescript":{"definition":"typings/index.d.ts"},"description":"gh-pages publishing plugin for semantic-release","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2019 QIWI\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","dependencies":{"debug":"^4.3.4","execa":"^5.1.1","tslib":"^2.6.2","lodash":"^4.17.21","queuefy":"^1.2.1","gh-pages":"^6.1.1","read-pkg":"^5.2.0","then-request":"^6.0.2","git-url-parse":"^14.0.0","aggregate-error":"^3.1.0","@qiwi/substrate-types":"^2.1.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"packageManager":"yarn@1.22.22+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610","devDependencies":{"jest":"^29.7.0","eslint":"^8.56.0","mkdirp":"^3.0.1","rimraf":"^5.0.5","cpy-cli":"^5.0.0","ts-jest":"^29.1.2","typedoc":"^0.25.7","typescript":"5.3.3","@types/jest":"^29.5.11","@types/debug":"^4.1.12","@types/lodash":"^4.14.202","@qiwi/libdefkit":"6.1.3","@types/gh-pages":"^6.1.0","@qiwi/npm-run-all":"^4.1.7","eslint-config-qiwi":"^2.1.3","@types/git-url-parse":"^9.0.3","eslint-config-prettier":"^9.1.0","@types/semantic-release":"^20.0.6"},"_npmOperationalInternal":{"tmp":"tmp/semantic-release-gh-pages-plugin_5.2.12_1733095318509_0.8889759036367675","host":"s3://npm-registry-packages"}},"5.2.13":{"name":"@dvirtz/semantic-release-gh-pages-plugin","version":"5.2.13","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 rimraf,mkdirp,typedoc,tslib,@swissquote/crafty-preset-jest,@types/jest,semantic-release","test:depaudit":"yarn audit --level=moderate --groups=dependencies; [[ $? -ge 4 ]] && exit 1 || exit 0","test:depauditfix":"npm_config_yes=true npx yarn-audit-fix --audit-level=moderate","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/ --flat","build:libdef":"libdefkit --tsconfig=tsconfig.es5.json --tsconfig=tsconfig.es6.json","docs":"typedoc src/main/ts","postupdate":"yarn && npm_config_yes=true npx yarn-audit-fix && yarn test:deps && yarn build && yarn test","publish:beta":"npm publish --no-git-tag-version --tag beta"},"dependencies":{"@qiwi/substrate-types":"^2.1.0","aggregate-error":"^3.1.0","debug":"^4.3.4","execa":"^5.1.1","gh-pages":"^6.1.1","git-url-parse":"^14.0.0","lodash":"^4.17.21","queuefy":"^1.2.1","read-pkg":"^5.2.0","then-request":"^6.0.2","tslib":"^2.6.2"},"devDependencies":{"@types/debug":"^4.1.12","@types/git-url-parse":"^9.0.3","@types/semantic-release":"^20.0.6","@types/gh-pages":"^6.1.0","@types/lodash":"^4.14.202","@qiwi/libdefkit":"6.1.3","@qiwi/npm-run-all":"^4.1.7","@types/jest":"^29.5.11","jest":"^29.7.0","cpy-cli":"^5.0.0","mkdirp":"^3.0.1","rimraf":"^5.0.5","ts-jest":"^29.1.2","eslint":"^8.56.0","eslint-config-prettier":"^9.1.0","eslint-config-qiwi":"^2.1.3","typedoc":"^0.25.7","typescript":"5.3.3"},"repository":{"type":"git","url":"git+https://github.com/dvirtz/semantic-release-gh-pages-plugin.git"},"bugs":{"url":"https://github.com/dvirtz/semantic-release-gh-pages-plugin/issues"},"author":{"name":"Anton Golub","email":"mailbox@antongolub.ru"},"license":"MIT","_id":"@dvirtz/semantic-release-gh-pages-plugin@5.2.13","gitHead":"2191d51014479259727f73f6fcea4887867d3bb9","homepage":"https://github.com/dvirtz/semantic-release-gh-pages-plugin#readme","_nodeVersion":"20.18.1","_npmVersion":"10.8.2","dist":{"integrity":"sha512-HoGvM2wPf9IpsOJVcpX/tokxi33C6kzX3/KfFD+6JIlF4Ri6SkEwJbee4KdNlnCS55/lFoAkeuYk/5hED9UcUA==","shasum":"2495f81d60db78b894b8cc05ddce4e7193fdb50e","tarball":"https://registry.npmjs.org/@dvirtz/semantic-release-gh-pages-plugin/-/semantic-release-gh-pages-plugin-5.2.13.tgz","fileCount":27,"unpackedSize":114566,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@dvirtz%2fsemantic-release-gh-pages-plugin@5.2.13","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCoOSWb5cu1ed4c1PiPUlfCNJ0aNYq+LTVNd5M14zGlEAIgJffbdIZca3qhnTUNKcHEd+Q30LxCntkALX0nnzpUZrI="}]},"_npmUser":{"name":"dvirtz","email":"dvirtz@gmail.com"},"directories":{},"maintainers":[{"name":"dvirtz","email":"dvirtz@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-gh-pages-plugin_5.2.13_1733272198783_0.27517491694792806"},"_hasShrinkwrap":false}},"time":{"created":"2024-12-01T23:21:58.372Z","modified":"2024-12-04T00:29:59.438Z","5.2.12":"2024-12-01T23:21:58.665Z","5.2.13":"2024-12-04T00:29:58.984Z"},"bugs":{"url":"https://github.com/dvirtz/semantic-release-gh-pages-plugin/issues"},"author":{"name":"Anton Golub","email":"mailbox@antongolub.ru"},"license":"MIT","keywords":["gh-pages","ghpages","github pages","semantic-release","semantic release"],"repository":{"type":"git","url":"git+https://github.com/dvirtz/semantic-release-gh-pages-plugin.git"},"description":"gh-pages publishing plugin for semantic-release","maintainers":[{"name":"dvirtz","email":"dvirtz@gmail.com"}],"readme":"# @wiki/semantic-release-gh-pages-plugin\n\n[![CI](https://github.com/wiki/semantic-release-gh-pages-plugin/workflows/CI/badge.svg)](https://github.com/wiki/semantic-release-gh-pages-plugin/actions)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/c149b0666dda28813aa4/test_coverage)](https://codeclimate.com/github/wiki/semantic-release-gh-pages-plugin/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/c149b0666dda28813aa4/maintainability)](https://codeclimate.com/github/wiki/semantic-release-gh-pages-plugin/maintainability)\n[![npm (tag)](https://img.shields.io/npm/v/@wiki/semantic-release-gh-pages-plugin/latest.svg)](https://www.npmjs.com/package/@wiki/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 configuration. |\n| `publish` | Pushes commit to the [documentation branch](#options) |\n\n## Install\n```bash\n# yarn\nyarn add @wiki/semantic-release-gh-pages-plugin --dev\n# npm\nnpm i @wiki/semantic-release-gh-pages-plugin -D\n```\n\n## Usage\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 \"@wiki/semantic-release-gh-pages-plugin\"\n ],\n \"publish\": [\n \"@semantic-release/npm\",\n \"@semantic-release/github\",\n [\n \"@wiki/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 \"@wiki/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` | **Optional.** 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| `branches` | Optional list of src-to-target branches association. If defined it suppresses `branch` option. For example, `[['master', 'gh-pages'], ['beta', beta-docs]]` | undefined |\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| `pattern` | gh-pages [src](https://github.com/tschaub/gh-pages#optionssrc) option | `**/*` |\n\n## License\n[MIT](./LICENSE)\n","readmeFilename":"README.md","homepage":"https://github.com/dvirtz/semantic-release-gh-pages-plugin#readme"}