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

EkoCommunications/action-check-pr-title

ย 
ย 

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 ๐ŸŽ‰

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 68.8%
  • TypeScript 31.2%