https://github.com/welpo/git-sumi-action

Lints Pull Request titles with git-sumi
https://github.com/welpo/git-sumi-action

commit-messages conventional-commits conventions github-actions lint pull-requests

Last synced: 14 days ago
JSON representation

Lints Pull Request titles with git-sumi

• Host: GitHub
• URL: https://github.com/welpo/git-sumi-action
• Owner: welpo
• License: apache-2.0
• Created: 2024-02-04T14:52:49.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-09-27T02:30:00.000Z (about 2 months ago)
• Last Synced: 2024-10-11T01:49:34.430Z (about 1 month ago)
• Topics: commit-messages, conventional-commits, conventions, github-actions, lint, pull-requests
• Language: Shell
• Homepage: https://sumi.rs
• Size: 71.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


    

        

    

    



    

    

        

    

      



# 🏮 Run git-sumi Action

This GitHub action runs [git-**sumi**](https://sumi.rs) to validate a Pull Request title using the `sumi.toml` configuration set up in the root of your repository.

## Usage

1. Add 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).

2. In your repository, create the workflow file `.github/workflows/git-sumi.yaml` with the following content:

```yaml

name: Lint pull request title

on:

  pull_request:

    types:

      - opened

      - edited

      - synchronize

      - ready_for_review

permissions:

  pull-requests: read

jobs:

  main:

    name: Run git-sumi

    runs-on: ubuntu-latest

    steps:

      - uses: welpo/git-sumi-action@main

        env:

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

This workflow will run on every pull request event, checking the title against the rules defined in `sumi.toml`.

3. Commit and push the workflow file to your repository.

4. That's it! The action will run automatically on every pull request event. If the title doesn't meet the rules, the action will fail and the pull request will be marked as "failing".

## Questions?

Don'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:[email protected]?subject=[GitHub]%20git-sumi-action).

## License

This 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.