Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slashgear/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 🎉
https://github.com/slashgear/action-check-pr-title
action hacktoberfest lint
Last synced: 14 days ago
JSON representation
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 🎉
- Host: GitHub
- URL: https://github.com/slashgear/action-check-pr-title
- Owner: Slashgear
- License: mit
- Created: 2020-11-28T12:43:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T13:35:45.000Z (7 months ago)
- Last Synced: 2024-10-29T15:23:44.290Z (2 months ago)
- Topics: action, hacktoberfest, lint
- Language: JavaScript
- Homepage:
- Size: 17.1 MB
- Stars: 25
- Watchers: 3
- Forks: 18
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
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
```yaml
steps:
- uses: Slashgear/[email protected]
with:
regexp: "([a-z])+" # Regex the title should match.
```
### Customize Regexp
```yaml
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
```yaml
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\_](https://twitter.com/Slashgear_)
- Github: [@Slashgear](https://github.com/Slashgear)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Slashgear/action-check-pr-title/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2020 [Slashgear](https://github.com/Slashgear).
This project is [MIT](https://github.com/Slashgear/action-check-pr-title/blob/main/LICENSE) licensed.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_