{"id":19602685,"url":"https://github.com/qiwi/semantic-release-gh-pages-plugin","last_synced_at":"2025-04-07T13:05:31.423Z","repository":{"id":34260180,"uuid":"172062491","full_name":"qiwi/semantic-release-gh-pages-plugin","owner":"qiwi","description":"github-pages publishing plugin for semantic-release","archived":false,"fork":false,"pushed_at":"2025-03-27T23:16:24.000Z","size":2877,"stargazers_count":24,"open_issues_count":6,"forks_count":8,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-31T12:04:12.499Z","etag":null,"topics":["gh-pages","semrel"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qiwi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-22T12:26:44.000Z","updated_at":"2025-03-27T23:15:48.000Z","dependencies_parsed_at":"2023-11-21T00:32:11.383Z","dependency_job_id":"94027b47-7b4b-45e8-8deb-1d2d4f472b00","html_url":"https://github.com/qiwi/semantic-release-gh-pages-plugin","commit_stats":{"total_commits":314,"total_committers":17,"mean_commits":"18.470588235294116","dds":0.60828025477707,"last_synced_commit":"d71d03a90d207a603974d1c478ebef2585c63569"},"previous_names":[],"tags_count":86,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiwi%2Fsemantic-release-gh-pages-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiwi%2Fsemantic-release-gh-pages-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiwi%2Fsemantic-release-gh-pages-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qiwi%2Fsemantic-release-gh-pages-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qiwi","download_url":"https://codeload.github.com/qiwi/semantic-release-gh-pages-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247657276,"owners_count":20974344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gh-pages","semrel"],"created_at":"2024-11-11T09:25:47.289Z","updated_at":"2025-04-07T13:05:31.379Z","avatar_url":"https://github.com/qiwi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @qiwi/semantic-release-gh-pages-plugin\n\n[![CI](https://github.com/qiwi/semantic-release-gh-pages-plugin/workflows/CI/badge.svg)](https://github.com/qiwi/semantic-release-gh-pages-plugin/actions)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/c149b0666dda28813aa4/test_coverage)](https://codeclimate.com/github/qiwi/semantic-release-gh-pages-plugin/test_coverage)\n[![Maintainability](https://api.codeclimate.com/v1/badges/c149b0666dda28813aa4/maintainability)](https://codeclimate.com/github/qiwi/semantic-release-gh-pages-plugin/maintainability)\n[![npm (tag)](https://img.shields.io/npm/v/@qiwi/semantic-release-gh-pages-plugin/latest.svg)](https://www.npmjs.com/package/@qiwi/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\n```bash\n# yarn\nyarn add @qiwi/semantic-release-gh-pages-plugin --dev\n# npm\nnpm i @qiwi/semantic-release-gh-pages-plugin -D\n```\n\n## Usage\n\nDescribe plugin configuration\nin [package.json / .releaserc.js](https://github.com/semantic-release/semantic-release/blob/master/docs/01-usage/plugins.md#plugins-configuration-options)\n\n```json\n{\n  \"release\": {\n    \"branch\": \"master\",\n    \"verifyConditions\": [\n      \"@semantic-release/changelog\",\n      \"@semantic-release/npm\",\n      \"@semantic-release/git\",\n      \"@qiwi/semantic-release-gh-pages-plugin\"\n    ],\n    \"publish\": [\n      \"@semantic-release/npm\",\n      \"@semantic-release/github\",\n      [\n        \"@qiwi/semantic-release-gh-pages-plugin\",\n        {\n          \"msg\": \"updated\",\n          \"branch\": \"docs\"\n        }\n      ]\n    ]\n  }\n}\n```\n\nor even shorter if default settings are used:\n\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      \"@qiwi/semantic-release-gh-pages-plugin\"\n    ]\n  }\n}\n```\n\n## Configuration\n\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 \u003c%= nextRelease.gitTag %\u003e`                                                                                                   |\n| `src`            | Documentation directory. Used as gh-pages [dir](https://github.com/tschaub/gh-pages?tab=readme-ov-file#dir)                                                 | `docs`\u003cbr/\u003e\u003cbr/\u003e**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. gh-pages [dest](https://github.com/tschaub/gh-pages?tab=readme-ov-file#optionsdest)                                                  | `.` (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. Use `:` to separate several values `**/*.md:**/*.png`                                | `**/*`                                                                                                                                     |\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiwi%2Fsemantic-release-gh-pages-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqiwi%2Fsemantic-release-gh-pages-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqiwi%2Fsemantic-release-gh-pages-plugin/lists"}