{"id":18952289,"url":"https://github.com/step-security/conventional-pr-title-action","last_synced_at":"2026-02-09T08:08:31.699Z","repository":{"id":210511238,"uuid":"726741031","full_name":"step-security/conventional-pr-title-action","owner":"step-security","description":"Ensure your PR title matches the Conventional Commits spec.","archived":false,"fork":false,"pushed_at":"2025-02-20T06:01:07.000Z","size":402,"stargazers_count":0,"open_issues_count":12,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-20T07:21:44.257Z","etag":null,"topics":["step-security-maintained-actions"],"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/step-security.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-03T08:53:57.000Z","updated_at":"2025-02-20T06:01:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"61a029ac-eb2a-486b-a877-611b8ced5150","html_url":"https://github.com/step-security/conventional-pr-title-action","commit_stats":null,"previous_names":["step-security/conventional-pr-title-action"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/step-security%2Fconventional-pr-title-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/step-security%2Fconventional-pr-title-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/step-security%2Fconventional-pr-title-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/step-security%2Fconventional-pr-title-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/step-security","download_url":"https://codeload.github.com/step-security/conventional-pr-title-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239951607,"owners_count":19723909,"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":["step-security-maintained-actions"],"created_at":"2024-11-08T13:32:36.423Z","updated_at":"2026-02-09T08:08:31.510Z","avatar_url":"https://github.com/step-security.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StepSecurity Maintained Conventional PR Title Action\n\nForked from: [aslafy-z/conventional-pr-title-action](https://github.com/aslafy-z/conventional-pr-title-action)\n\nThis is a [GitHub Action](https://github.com/features/actions) that ensures your PR title matches the [Conventional Commits spec](https://www.conventionalcommits.org/).\n\nThis is helpful when you're using [semantic-release](https://github.com/semantic-release/semantic-release) with the Conventional Commits preset. When using the `Squash and merge` strategy, GitHub will suggest to use the PR title as the commit message. With this action you can validate that the PR title will lead to a correct commit message.\n\nSee [Conventional Commits](https://www.conventionalcommits.org/) for sample titles.\n\n## Inputs\n\n### `success-state`\n\n**Optional.** Description of the status check if validation succeeds.\n\u003e Default: `\"Title follows the specification.\"`.\n\n### `failure-state`\n\n**Optional.** Description of the status check if validation fails.\n\u003e Default: `\"Title does not follow the specification.\"`.\n\n### `context-name`\n\n**Optional.** Persistent status check context key. \n\u003e Default: `\"conventional-pr-title\"`.\n\n### `preset`\n\n**Optional.** Conventional changelog preset.\n\u003e Default: `\"conventional-changelog-conventionalcommits@5.0.0\"`.\n\n### `target-url`\n\n**Optional.** URL to be used when linking the \"Details\" in the actions overview.\n\u003e Default: `\"https://www.conventionalcommits.org/en/v1.0.0/#summary\"`.\n\n## Outputs\n\n### `success`\n\n`true` if the validation succeed, `false` otherwise.\n\n### `error`\n\nIn case of an error (`success=false`), contains the error message for additional processing or usage in notifications.\n\n## Example usage\n\n```yaml\nname: Check PR title\n\non:\n  pull_request_target:\n    types:\n      - opened\n      - reopened\n      - edited\n      - synchronize\n\njobs:\n  lint:\n    runs-on: ubuntu-latest\n    permissions:\n      statuses: write\n    steps:\n      - uses: step-security/conventional-pr-title-action@v3\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n\u003e Note: Avoid using `main` ref, prefer to pin to a specific version.\n\n## Credits\n\nAll thanks goes to [`amannn`](https://github.com/amannn)'s [`semantic-pull-request`](https://github.com/amannn/action-semantic-pull-request) action.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstep-security%2Fconventional-pr-title-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstep-security%2Fconventional-pr-title-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstep-security%2Fconventional-pr-title-action/lists"}