{"id":15140230,"url":"https://github.com/z0al/commitlint-bot","last_synced_at":"2025-09-29T08:31:48.762Z","repository":{"id":57204203,"uuid":"108747632","full_name":"z0al/commitlint-bot","owner":"z0al","description":"[NOT MAINTAINED] use https://github.com/apps/semantic-pull-requests","archived":true,"fork":false,"pushed_at":"2019-10-11T17:40:52.000Z","size":1203,"stargazers_count":151,"open_issues_count":0,"forks_count":24,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-11T12:35:05.213Z","etag":null,"topics":["bot","commit-message","commitlint","github-app","probot","probot-app"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/z0al.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-29T15:46:11.000Z","updated_at":"2023-08-25T16:43:52.000Z","dependencies_parsed_at":"2022-08-29T18:01:41.970Z","dependency_job_id":null,"html_url":"https://github.com/z0al/commitlint-bot","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/z0al%2Fcommitlint-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z0al%2Fcommitlint-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z0al%2Fcommitlint-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/z0al%2Fcommitlint-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/z0al","download_url":"https://codeload.github.com/z0al/commitlint-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234604488,"owners_count":18859164,"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":["bot","commit-message","commitlint","github-app","probot","probot-app"],"created_at":"2024-09-26T08:01:39.755Z","updated_at":"2025-09-29T08:31:43.392Z","avatar_url":"https://github.com/z0al.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# commitlint [bot]\n\n[![Travis](https://img.shields.io/travis/z0al/commitlint-bot.svg)](https://travis-ci.org/z0al/commitlint-bot)\n[![npm](https://img.shields.io/npm/v/commitlint-bot.svg)](https://www.npmjs.com/package/commitlint-bot)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/robot.svg\" width=\"256\" alt=\"commitlint logo\" /\u003e\n\u003c/p\u003e\n\n\u003e Built with [probot](https://github.com/probot/probot) framework\n\nA GitHub App that runs [commitlint](https://github.com/marionebl/commitlint) against all commits of new or edited pull requests\nand sets an appropriate status check.\n\n## Usage\n\n1.  Browse to [GitHub Apps - commitlint][apps]\n2.  Accept the permissions\n3.  Allow access to repositories\n\nOn the next pull request, a status check from `commitlint` will appear:\n\n![status-check-screenshot][]\n\nProblem details will be reported as a comment like this:\n\n![status-comment-screenshot][]\n\nFor best results, enable branch protection (in the repository's settings) and require the `commitlint` status check to pass before merging:\n\n![branch-protection-screenshot][]\n\n[apps]: https://github.com/apps/commitlint\n[status-check-screenshot]: docs/status.png\n[status-comment-screenshot]: docs/comment.png\n[branch-protection-screenshot]: docs/setting.png\n\n## What is missing?\n\nWe don't currently support custom configuration (i.e. `.commitlint.yml` or `.commitlint.json`), but [we will](https://github.com/z0al/commitlint-bot/issues/1)\n\n## Development\n\n1.  Setup the repo:\n\n```shell\ngit clone https://github.com/z0al/commitlint-bot.git\ncd commitlint-bot\nnpm install\n```\n\n2.  Create your own [GitHub app][]\n3.  Store the private key as `private-key.pem` somewhere safe, and point to its location in `.env`\n4.  Start the app with `APP_ID=1234 npm start` where `1234` is your GitHub app's ID\n5.  Update your GitHub app's Webhook URL to your localtunnel.me URL\n\n[github app]: https://probot.github.io/docs/development/#configure-a-github-app\n\n## Deployment\n\nSee [docs/deploy.md](./docs/deploy.md) for more info.\n\n## Credits\n\nRobot designed by [Freepik](https://www.freepik.com/free-vector/fun-pack-of-robots-avatars_1258314.htm).\n\nInspired by the awesome work of Tom Vincent in their [validate-commit-msg-bot](https://github.com/tlvince/validate-commit-msg-bot) package.\n\n## Like it?\n\nGive it a star(:star:) :point_up_2:\n\n## License\n\nMIT © [Ahmed T. Ali](https://github.com/z0al)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz0al%2Fcommitlint-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fz0al%2Fcommitlint-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fz0al%2Fcommitlint-bot/lists"}