https://github.com/dcdavidev/namae-no-eda

Keep your branch names tidy, like leaves on a tree
https://github.com/dcdavidev/namae-no-eda

actions ci ci-cd cicd github-actions lint linter linting linting-workflow workflow-automation

Last synced: 2 months ago
JSON representation

Keep your branch names tidy, like leaves on a tree

• Host: GitHub
• URL: https://github.com/dcdavidev/namae-no-eda
• Owner: dcdavidev
• License: mit
• Created: 2025-09-23T14:31:03.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2026-02-23T11:07:26.000Z (4 months ago)
• Last Synced: 2026-04-03T10:47:18.602Z (3 months ago)
• Topics: actions, ci, ci-cd, cicd, github-actions, lint, linter, linting, linting-workflow, workflow-automation
• Language: Shell
• Homepage:
• Size: 5.01 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  



namae-no-eda (名前の枝, "branch name")

Keep your branch names tidy, like leaves on a tree




  



## Example

This workflow validates branch names using `namae-no-eda`.  

By default it allows:  

`feat/*, fix/*, chore/*, docs/*, refactor/*, test/*, perf/*`  

and excludes:  

`main, release/*`.

```yaml

name: Branch Lint

on:

  pull_request:

    branches:

      - '**'

  push:

    branches:

      - '**'

jobs:

  branch-lint:

    runs-on: ubuntu-latest

    steps:

      - name: Check out repository

        uses: actions/checkout@v4

      - name: Validate branch name

        uses: dcdavidev/namae-no-eda@v0.0.1 # Check latest release first.

        # with:

        #   allowed: 'fix/*,feature/*,release/*' # Optional

        #   exclude: 'main,develop' # Optional

```

## How it works

- **allowed** _(optional)_: Comma-separated glob patterns. Defaults to `feat/*,fix/*,chore/*,docs/*,refactor/*,test/*,perf/*`.

- **exclude** _(optional)_: Comma-separated exact branch names. Defaults to `main,release/*`.

- **branch_name** _(optional)_: Branch to check. Defaults to the branch that triggered the workflow.

If the branch name does not match any allowed patterns and is not excluded, the action will fail the workflow.

## Code Reviews

![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/dcdavidev/namae-no-eda?utm_source=oss&utm_medium=github&utm_campaign=dcdavidev%2Fnamae-no-eda&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)

## 📄 License

This repository is licensed under the MIT License.