action-check-pr-title
action-check-pr-title copied to clipboard
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 ru...
Welcome to action-check-pr-title 👋
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
- Website: https://blog.slashgear.dev/
- Twitter: @Slashgear_
- Github: @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