{"id":15693648,"url":"https://github.com/leko/reg-publish-github-pages-plugin","last_synced_at":"2025-05-07T08:26:57.311Z","repository":{"id":36954807,"uuid":"331813719","full_name":"Leko/reg-publish-github-pages-plugin","owner":"Leko","description":"A reg-suit plugin to publish reports on GitHub pages","archived":false,"fork":false,"pushed_at":"2023-01-23T09:08:59.000Z","size":1753,"stargazers_count":7,"open_issues_count":25,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-29T14:46:52.226Z","etag":null,"topics":["automation-tests","nodejs","reg-suit","regression-testing","visual-tests"],"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/Leko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-22T02:26:01.000Z","updated_at":"2023-07-11T15:11:40.000Z","dependencies_parsed_at":"2023-02-12T21:40:16.304Z","dependency_job_id":null,"html_url":"https://github.com/Leko/reg-publish-github-pages-plugin","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Leko%2Freg-publish-github-pages-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Leko%2Freg-publish-github-pages-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Leko%2Freg-publish-github-pages-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Leko%2Freg-publish-github-pages-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Leko","download_url":"https://codeload.github.com/Leko/reg-publish-github-pages-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252841453,"owners_count":21812481,"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":["automation-tests","nodejs","reg-suit","regression-testing","visual-tests"],"created_at":"2024-10-03T18:46:55.195Z","updated_at":"2025-05-07T08:26:57.280Z","avatar_url":"https://github.com/Leko.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# reg-publish-github-pages-plugin\n\n![version](https://img.shields.io/npm/v/reg-publish-github-pages-plugin)\n![LICENSE](https://img.shields.io/npm/l/reg-publish-github-pages-plugin)\n\nA reg-suit plugin to fetch and publish assets to the GitHub pages.\n\n## How it works\n\n![overview](./docs/overview.png)\n\nThe plugin will create [orphan branch](https://git-scm.com/docs/git-checkout#Documentation/git-checkout.txt---orphanltnewbranchgt) when you run `reg-suit prepare -p publish-github-pages`. Then the plugin will commit report pages and images to the branch whenever you run `reg-suit run`. The branch has completely different tree from your branches. It doesn't affect any existing branches. So you can use it in the same repository you want to introduce reg-suit.\n\n## Install\n\n```sh\nnpm i -D reg-publish-github-pages-plugin\nreg-suit prepare -p publish-github-pages\n```\n\n## Setup\n\nYou need to configure GitHub pages before using this plugin.  \n[See the official documentation](https://docs.github.com/en/github/working-with-github-pages)\n\n## Configure\n\n```ts\n{\n  repository: string;\n  branchName: string;\n  token: string;\n  customDomain?: string;\n  pathPrefix?: string;\n}\n```\n\n- `repository` - _Required_ - A repository name in the form of `owner/name` such as `Leko/reg-publish-github-pages-plugin`.\n- `branchName` - _Required_ - A branch name for the GitHub pages.\n- `token` - _Required_ - A GitHub token. The token must have `user:email` and `public_repo` permission. When the repository is private, the token requires `repo` permission instead of `public_repo`.\n- `customDomain` - _Optional_ - A custom domain when you set it to the GitHub pages.\n- `pathPrefix` - _Optional_ - Specify paths. For example, when you set `some_dir` as this property, this plugin will publish with URL such as `https://{TODO}/some_dir/index.html`.\n\n## See also\n\n- [Embed environment values](https://github.com/reg-viz/reg-suit#embed-environment-values)\n\n## LICENSE\n\nThis repository is under [MIT](./LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleko%2Freg-publish-github-pages-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleko%2Freg-publish-github-pages-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleko%2Freg-publish-github-pages-plugin/lists"}