{"id":19341644,"url":"https://github.com/jef/conventional-commits-pr-action","last_synced_at":"2025-04-23T03:31:55.185Z","repository":{"id":37800767,"uuid":"341593240","full_name":"jef/conventional-commits-pr-action","owner":"jef","description":"🧐 Lints pull request titles for conventional commits","archived":false,"fork":false,"pushed_at":"2025-02-12T22:24:03.000Z","size":806,"stargazers_count":20,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-14T22:37:38.328Z","etag":null,"topics":["conventional-commits","github-actions"],"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/jef.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"jef","custom":["https://www.paypal.me/jxf"]}},"created_at":"2021-02-23T15:07:17.000Z","updated_at":"2025-02-12T22:23:44.000Z","dependencies_parsed_at":"2024-06-20T00:02:21.719Z","dependency_job_id":"f741fdc6-36ee-4b31-b54c-69b78af0b117","html_url":"https://github.com/jef/conventional-commits-pr-action","commit_stats":{"total_commits":51,"total_committers":3,"mean_commits":17.0,"dds":"0.43137254901960786","last_synced_commit":"840d1df3000ce6e775c571f5a6fc9963a26110da"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jef%2Fconventional-commits-pr-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jef%2Fconventional-commits-pr-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jef%2Fconventional-commits-pr-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jef%2Fconventional-commits-pr-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jef","download_url":"https://codeload.github.com/jef/conventional-commits-pr-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250365727,"owners_count":21418736,"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":["conventional-commits","github-actions"],"created_at":"2024-11-10T03:31:51.789Z","updated_at":"2025-04-23T03:31:55.178Z","avatar_url":"https://github.com/jef.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jef","https://www.paypal.me/jxf"],"categories":[],"sub_categories":[],"readme":"# conventional-commits-pr-action\n\nLints pull requests based on [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/).\n\nAlso has the ability to post a comment in the pull request conversation with examples.\n\n![image](https://user-images.githubusercontent.com/12074633/108867820-91325700-75c3-11eb-8820-4b55abe01c35.png)\n\nLive examples:\n\n- [With pull request comment](https://github.com/jef/conventional-commits-pr-action/pull/5)\n- [Without pull request comment](https://github.com/jef/conventional-commits-pr-action/pull/4)\n\n## Usage\n\n```yaml\nname: Pull Request Title Linter\non:\n  pull_request:\n    types:\n      - opened\n      - edited\n      - reopened\n      - synchronize\njobs:\n  pr_lint:\n    name: Lint pull request title\n    runs-on: ubuntu-latest\n    permissions:\n      pull-requests: write # post comments when 'comment' is true\n    steps:\n      - name: Lint pull request title\n        uses: jef/conventional-commits-pr-action@v1\n        with:\n          token: ${{ secrets.GITHUB_TOKEN }}\n\n```\n\n## Inputs\n\n### `bots_ignore`\n\n**Optional** A list of bots to ignore when linting the pull request title. Can be a comma-separated list.\n\n### `comment`\n\n**Optional** Post a comment in the pull request conversation with examples.\n\n| Default value | `true` |\n|---------------|--------|\n\n\u003e [!NOTE]\n\u003e Commenting in the pull request conversation requires that the token is configured with the `pull-requests` permission.\n\n### `token`\n\n**Required** Access token to the repository. Usually `${{ secrets.GITHUB_TOKEN }}`.\n\n## Contributing\n\nThere are few npm tasks that will help you in building and packaging. All commands are prefaced by `npm run`.\n\n- `build`: builds the action.\n- `clean`: removes `build` directory.\n- `compile`: transpiles TypeScript.\n- `fix`: fixes lint and format issues.\n- `lint`: runs linter and checks format issues.\n- `start`: runs the action.\n- `test`: tests the action.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjef%2Fconventional-commits-pr-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjef%2Fconventional-commits-pr-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjef%2Fconventional-commits-pr-action/lists"}