README.md

🏮 Run git-sumi Action

This GitHub action runs git-sumi 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 and rules documentation).

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

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, discussions, or email.

License

This project is licensed under the terms of both the MIT license and the Apache License (Version 2.0), at your option.