{"id":13633789,"url":"https://github.com/codechecks/commit-deployment","last_synced_at":"2026-07-06T02:31:30.648Z","repository":{"id":57102991,"uuid":"178909933","full_name":"codechecks/commit-deployment","owner":"codechecks","description":"Ship every code change that you make","archived":false,"fork":false,"pushed_at":"2019-05-22T23:20:59.000Z","size":236,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-05T19:48:56.588Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/codechecks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-01T17:08:28.000Z","updated_at":"2021-07-29T06:16:48.000Z","dependencies_parsed_at":"2022-08-20T23:50:58.814Z","dependency_job_id":null,"html_url":"https://github.com/codechecks/commit-deployment","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Fcommit-deployment","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Fcommit-deployment/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Fcommit-deployment/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Fcommit-deployment/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codechecks","download_url":"https://codeload.github.com/codechecks/commit-deployment/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240385235,"owners_count":19792980,"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":[],"created_at":"2024-08-01T23:00:51.765Z","updated_at":"2025-10-26T11:09:40.900Z","avatar_url":"https://github.com/codechecks.png","language":"TypeScript","funding_links":[],"categories":["Frontend development"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./meta/check.png\" width=\"700\" alt=\"codechecks.io\"\u003e\n  \u003ch3 align=\"center\"\u003eCommit Deployment\u003c/h3\u003e\n  \u003cp align=\"center\"\u003eShip every code change that you make\u003c/p\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://circleci.com/gh/codechecks/commit-deployment\"\u003e\u003cimg alt=\"Build Status\" src=\"https://circleci.com/gh/codechecks/commit-deployment/tree/master.svg?style=svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"/package.json\"\u003e\u003cimg alt=\"Software License\" src=\"https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n## Install\n\n```sh\nnpm add --save-dev @codechecks/commit-deployment\n```\n\nor\n\n```sh\nyarn add --dev @codechecks/commit-deployment\n```\n\n## Usage\n\nAdd to your `codechecks.yml` file:\n\n```yml\nchecks:\n  - name: commit-deployment\n    options:\n      buildPath: \"./dist\"\n  # ...\n```\n\nWith each pull request you will get a link do current deployment of your frontend app.\n\n## API\n\n### commitDeployment(options: Options): Promise\\\u003cvoid\u003e\n\n#### Options\n\n```typescript\ninterface Options {\n  buildPath: string;\n  rootFile?: string;\n}\n```\n\n##### buildPath\n\n`string`\u003cbr\u003e\\\nRelative (to current codechecks file) path to build that is supposed to be deployed.\n\n##### rootFile\n\noptional `string`\u003cbr\u003e\\\nDefault: `index.html`\u003cbr\u003e\\\nFile considered as root in your build. Attached link will point directly to it.\n\n## Contributing\n\nAll contributions are welcomed. Read more in [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n## Licence\n\nMIT @ [codechecks.io](https://codechecks.io)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodechecks%2Fcommit-deployment","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodechecks%2Fcommit-deployment","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodechecks%2Fcommit-deployment/lists"}