{"id":16157433,"url":"https://github.com/welpo/git-sumi-action","last_synced_at":"2026-05-02T02:39:30.848Z","repository":{"id":220852201,"uuid":"752693787","full_name":"welpo/git-sumi-action","owner":"welpo","description":"Lints Pull Request titles with git-sumi","archived":false,"fork":false,"pushed_at":"2024-09-27T02:30:00.000Z","size":73,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-11T01:49:34.430Z","etag":null,"topics":["commit-messages","conventional-commits","conventions","github-actions","lint","pull-requests"],"latest_commit_sha":null,"homepage":"https://sumi.rs","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/welpo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-04T14:52:49.000Z","updated_at":"2024-09-24T22:41:33.000Z","dependencies_parsed_at":"2024-02-19T22:25:14.697Z","dependency_job_id":"787951bc-d274-4fc7-b52e-ff34902f3432","html_url":"https://github.com/welpo/git-sumi-action","commit_stats":null,"previous_names":["welpo/git-sumi-action"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Fgit-sumi-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Fgit-sumi-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Fgit-sumi-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/welpo%2Fgit-sumi-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/welpo","download_url":"https://codeload.github.com/welpo/git-sumi-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247578620,"owners_count":20961269,"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":["commit-messages","conventional-commits","conventions","github-actions","lint","pull-requests"],"created_at":"2024-10-10T01:49:31.270Z","updated_at":"2026-05-02T02:39:30.835Z","avatar_url":"https://github.com/welpo.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://sumi.rs\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/welpo/git-sumi/main/website/static/img/logo.png\" width=\"300\" alt=\"git-sumi logo: a lantern held on a bamboo stick over the sea\"\u003e\n    \u003c/a\u003e\n    \u003cbr\u003e\u003cbr\u003e\n    \u003ca href=\"https://github.com/welpo/git-sumi-action/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/welpo/git-sumi-action?style=flat-square\u0026labelColor=202b2d\u0026color=b05275\" alt=\"GitHub version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://sumi.rs/docs\"\u003e\n        \u003cimg src=\"https://img.shields.io/website?url=https%3A%2F%2Fsumi.rs\u0026style=flat-square\u0026label=docs\u0026labelColor=202b2d\u0026color=b05275\" alt=\"Documentation\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/welpo/git-sumi\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square\u0026labelColor=202b2d\u0026color=b05275\" alt=\"Clean commits\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# 🏮 Run git-sumi Action\n\nThis GitHub action runs [git-**sumi**](https://sumi.rs) to validate Pull Request titles or lint commit ranges using the `sumi.toml` configuration set up in the root of your repository.\n\n## Inputs\n\n| Input | Description | Default |\n|-------|-------------|---------|\n| `mode` | Lint mode: `pr-title` or `commits` | `pr-title` |\n| `from` | Start of revision range (exclusive). Only for `commits` mode. | `origin/\u003cPR base branch\u003e` |\n| `to` | End of revision range (inclusive). Only for `commits` mode. | `HEAD` |\n\n## Usage\n\nAdd a `sumi.toml` file to the root of your repository, enabling the rules you want to use (see the [configuration](https://sumi.rs/docs/configuration/) and [rules](https://sumi.rs/docs/rules/) documentation).\n\n### Linting PR titles\n\nCreate the workflow file `.github/workflows/git-sumi.yaml`:\n\n```yaml\nname: Lint pull request title\n\non:\n  pull_request:\n    types:\n      - opened\n      - edited\n      - synchronize\n      - ready_for_review\n\npermissions:\n  pull-requests: read\n\njobs:\n  main:\n    name: Run git-sumi\n    runs-on: ubuntu-latest\n    steps:\n      - uses: welpo/git-sumi-action@main\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Linting commits\n\nTo lint all commits in a pull request, set `mode: commits`:\n\n```yaml\nname: Lint commits\n\non:\n  pull_request:\n    types:\n      - opened\n      - edited\n      - synchronize\n      - ready_for_review\n\npermissions:\n  pull-requests: read\n\njobs:\n  main:\n    name: Run git-sumi\n    runs-on: ubuntu-latest\n    steps:\n      - uses: welpo/git-sumi-action@main\n        with:\n          mode: commits\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\nBy default, this lints all commits between `origin/\u003cPR base branch\u003e` and `HEAD`. You can override the range:\n\n```yaml\n      - uses: welpo/git-sumi-action@main\n        with:\n          mode: commits\n          from: origin/develop\n          to: HEAD\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Questions?\n\nDon't hesitate to reach out via the [issue tracker](https://github.com/welpo/git-sumi-action/issues), [discussions](https://github.com/welpo/git-sumi-action/discussions), or [email](mailto:osc@osc.garden?subject=[GitHub]%20git-sumi-action).\n\n## License\n\nThis project is licensed under the terms of both the [MIT license](/LICENSE-MIT) and the [Apache License (Version 2.0)](/LICENSE-APACHE), at your option.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwelpo%2Fgit-sumi-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwelpo%2Fgit-sumi-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwelpo%2Fgit-sumi-action/lists"}