Skip to content

Github action to check Pull Request title based on JS Regexp This action in really simple and use Github Action core library base on event of your pull requests No need to install anything on your runner to use it. Simple, fast, reliable πŸŽ‰

License

Notifications You must be signed in to change notification settings

Slashgear/action-check-pr-title

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Welcome to action-check-pr-title πŸ‘‹

License: MIT Twitter: Slashgear_ Continous Integration

Github action to check Pull Request title based on JS Regexp

This action in really simple and use Github Action core library base on event of your pull requests No need to install anything on your runner to use it. Simple, fast, reliable πŸŽ‰

Usage

This action allows you to include a title check of a pull request automatically. This action only works on pull_request events.

To use it, add the following steps in your workflow:

Default usage

steps:
  - uses: Slashgear/[email protected]
    with:
      regexp: "([a-z])+" # Regex the title should match.

Customize Regexp

steps:
  - uses: Slashgear/[email protected]
    with:
      regexp: "([a-z])+" # Regex the title should match.
      flags: "i" # Flags to add to the regexp

Add helper message

steps:
  - uses: Slashgear/[email protected]
    with:
      regexp: "(feat|fix|docs): .++" # Regex the title should match.
      helpMessage: "Example: 'feat: example of title'"

Author

πŸ‘€ Slashgear

🀝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

πŸ“ License

Copyright Β© 2020 Slashgear.
This project is MIT licensed.


This README was generated with ❀️ by readme-md-generator

About

Github action to check Pull Request title based on JS Regexp This action in really simple and use Github Action core library base on event of your pull requests No need to install anything on your runner to use it. Simple, fast, reliable πŸŽ‰

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks