{"id":28715663,"url":"https://github.com/coolapso/convcommitlint","last_synced_at":"2025-06-15T02:10:38.789Z","repository":{"id":296433341,"uuid":"993339854","full_name":"coolapso/convcommitlint","owner":"coolapso","description":"Slightly opinionated, yet functional linter for conventional commits! No I don't want to support all your different variants of conventional commits! ","archived":false,"fork":false,"pushed_at":"2025-05-30T19:56:58.000Z","size":3033,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-31T01:10:41.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/coolapso.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"coolapso","buy_me_a_coffee":"coolapso"}},"created_at":"2025-05-30T16:09:26.000Z","updated_at":"2025-05-30T17:06:20.000Z","dependencies_parsed_at":"2025-05-31T01:11:48.771Z","dependency_job_id":"104e1c1f-6eae-4ab8-8b8b-2c2836e0e44b","html_url":"https://github.com/coolapso/convcommitlint","commit_stats":null,"previous_names":["coolapso/convcommitlint"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/coolapso/convcommitlint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coolapso%2Fconvcommitlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coolapso%2Fconvcommitlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coolapso%2Fconvcommitlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coolapso%2Fconvcommitlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coolapso","download_url":"https://codeload.github.com/coolapso/convcommitlint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coolapso%2Fconvcommitlint/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259910742,"owners_count":22930713,"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":"2025-06-15T02:10:38.243Z","updated_at":"2025-06-15T02:10:38.783Z","avatar_url":"https://github.com/coolapso.png","language":"Go","funding_links":["https://github.com/sponsors/coolapso","https://buymeacoffee.com/coolapso","https://www.buymeacoffee.com/coolapso"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/coolapso/convcommitlint/blob/main/images/logo.png\" width=\"200\" \u003e\n\u003c/p\u003e\n\n# CONVCOMMITLINT\n\n[![Release](https://github.com/coolapso/convcommitlint/actions/workflows/release.yaml/badge.svg?branch=main)](https://github.com/coolapso/convcommitlint/actions/workflows/release.yaml)\n![GitHub Tag](https://img.shields.io/github/v/tag/coolapso/convcommitlint?logo=semver\u0026label=semver\u0026labelColor=gray\u0026color=green)\n[![Docker image version](https://img.shields.io/docker/v/coolapso/convcommitlint/latest?logo=docker)](https://hub.docker.com/r/coolapso/convcommitlint)\n[![Go Report Card](https://goreportcard.com/badge/github.com/coolapso/convcommitlint)](https://goreportcard.com/report/github.com/coolapso/convcommitlint)\n![GitHub Sponsors](https://img.shields.io/github/sponsors/coolapso?style=flat\u0026logo=githubsponsors)\n\nA simple, slightly opinionated, but actually *usable* linter for [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), written in Go.\n\n---\n\n## Motivation\n\nI just wanted something that *works* out of the box. No over-configuration, no headaches—just simple commit linting! This being said, this linter covers the essentials. Contributions are welcome, but I don’t intend to support every possible variation or custom rule!\n\n---\n\n## Features\n\n- **Checks header syntax**\n- **Detects common typos** in key keywords: `fix`, `feat`, and `BREAKING CHANGE`\n- **GitHub Pull Request Reviews:**\n  - Request changes (default)\n  - Comment-only mode\n- **Lint Modes:**\n  - Lint only the current commit\n  - Lint all commits\n  - Lint only recent commits from the base branch\n- **Full environment variable support** for all flags\n- **Cross-platform:** Linux, macOS, and Windows\n- **GitHub Action** support\n\n---\n\n## How It Works\n\n`convcommitlint` checks your commits against the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.  \nIf you use it as a GitHub Action or enable PR review, it will comment or request changes directly on your pull requests, listing any issues it finds.\n\n---\n\n## Usage\n\n```\n  convcommitlint [flags]\n  convcommitlint [command]\n\nAvailable Commands:\n  completion  Generate the autocompletion script for the specified shell\n  help        Help about any command\n  version     Print convcommitlint version\n\nFlags:\n  -b, --base-branch string   The base branch to check commits from (default \"main\")\n      --comment-only         Pull request reviews will only comment instead of requesting changes\n  -r, --create-review        Creates review on github pull request\n  -c, --current              Lint only the current commit\n  -h, --help                 help for convcommitlint\n  -a, --lint-all             Lint all repository commits\n  -p, --path string          Git repository path (default \"./\")\n      --pr-number int        The number of pull request to create the review\n      --repository string    The github repository in owner/name format ex: coolapso/convcommitlint\n\nUse \"convcommitlint [command] --help\" for more information about a command.\n```\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/coolapso/convcommitlint/refs/heads/main/images/demo.gif\"\u003e\n\u003c/p\u003e\n\n\n### Environment Variables\n\nEvery flag can also be set with an environment variable, using the `CONVCOMMITLINT_` prefix, uppercase, and underscores.  \nFor example, the flag `--lint-all` becomes the variable `CONVCOMMITLINT_LINT_ALL`.\n\n---\n\n## GitHub Action\n\nYou can use `convcommitlint` as part of your CI pipeline. Most CLI arguments are supported as action inputs.\n\n```yaml\nconvcommitlint:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v4\n    - uses: coolapso/convcommitlint@v0\n```\n\n### Base Branch\n\nBy default, the base branch is `\"main\"`. If you use a different default branch, set the `base-branch` input:\n\n```yaml\nconvcommitlint:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v4\n    - uses: coolapso/convcommitlint@v0\n      with: \n        base-branch: develop\n```\n\n### Git History Depth\n\nBy default, the action checks out the reference branch with full history. To limit this, use the `fetch-depth` input (commits beyond this depth will *not* be analyzed):\n\n```yaml\nconvcommitlint:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v4\n    - uses: coolapso/convcommitlint@v0\n      with: \n        fetch-depth: 10\n```\n\n### Disable Pull Request Reviews\n\nPR reviews are enabled by default. To disable them, set `create-review` to `\"false\"`:\n\n```yaml\nconvcommitlint:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v4\n    - uses: coolapso/convcommitlint@v0\n      with: \n        create-review: \"false\"\n```\n\n### Use a Specific Version\n\nThe action uses the latest release by default. To pin a specific version:\n\n```yaml\nconvcommitlint:\n  runs-on: ubuntu-latest\n  steps:\n    - uses: actions/checkout@v4\n    - uses: coolapso/convcommitlint@v0\n      with: \n        version: v0.2.0\n```\n\n### Other Features \u0026 Flags\n\nThe action supports all CLI features and flags.  \nCheck available inputs in [`action.yaml`](action.yaml).  \nIf an input is missing, you can always set the corresponding environment variable.\n\n---\n\n## Installation\n\n### Docker\n\nImages are available on both DockerHub and GitHub Container Registry (ghcr.io):\n\n**GitHub Container Registry:**\n\n```sh\ndocker run -v $(pwd):/data --rm ghcr.io/coolapso/convcommitlint:latest\n```\n\n**DockerHub:**\n\n```sh\ndocker run -v $(pwd):/data --rm coolapso/convcommitlint:latest\n```\n\n### Go Install\n\n#### Latest Version\n\n```sh\ngo install github.com/coolapso/convcommitlint@latest\n```\n\n#### Specific Version\n\n```sh\ngo install github.com/coolapso/convcommitlint@v1.0.0\n```\n\n### Arch Linux (AUR)\n\nOn Arch Linux, use the AUR package: `convcommitlint-bin`.\n\n### Linux Install Script\n\nInstall on any Linux distro using the script:\n\n#### Latest Version\n\n```sh\ncurl -L http://commitlint.coolapso.sh/install.sh | bash\n```\n\n#### Specific Version\n\n```sh\ncurl -L http://commitlint.coolapso.sh/install.sh | VERSION=\"v1.1.0\" bash\n```\n\n\n### Manual Install\n\n- Download the binary from the [releases page](https://github.com/coolapso/convcommitlint/releases)\n- Extract the binary\n- Run it\n\n### Build\n\n```sh\ngo build -o convcommitlint\n```\n\n---\n\n## Contributions\n\nImprovements and suggestions are always welcome!  \nCheck open issues, or open a new Issue or Pull Request.\n\nIf you like this project and want to support or contribute in another way, you can [:heart: Sponsor Me](https://github.com/sponsors/coolapso) or:\n\n\u003ca href=\"https://www.buymeacoffee.com/coolapso\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 51px !important;width: 217px !important;\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoolapso%2Fconvcommitlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoolapso%2Fconvcommitlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoolapso%2Fconvcommitlint/lists"}