https://github.com/slashgear/flo-du-bot

🤖 Github action to ensure that test are added to a project for new features or bug fixes
https://github.com/slashgear/flo-du-bot

action github pull-requests test

Last synced: 12 months ago
JSON representation

🤖 Github action to ensure that test are added to a project for new features or bug fixes

• Host: GitHub
• URL: https://github.com/slashgear/flo-du-bot
• Owner: Slashgear
• License: mit
• Created: 2023-01-07T12:36:50.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-17T08:33:21.000Z (about 2 years ago)
• Last Synced: 2024-04-25T09:01:23.831Z (almost 2 years ago)
• Topics: action, github, pull-requests, test
• Language: TypeScript
• Homepage:
• Size: 487 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 8
• 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 flo-du-bot Github Action👋



  

    

  

  

    

  

  

    

  



> Github action to ensure that test are added to a project for new features or bug fixes.

>

> By default, when a pull request is opened and is name contains `feat` or `fix`, the action will fail if the list of files changes does not match

## Context of this action

With my colleague [Florent Dubost](https://github.com/fdubost), we try to instill in our development teams the need to always try to implement automated tests in the Pull Requests on which they modify the product of our tools.

**This is part of our "team rules" that we try to respect.**

As we presented in the article in french ["How not to throw away a frontend application every two years?](https://tech.bedrockstreaming.com/2021/09/01/bonnes-pratiques-web.html), we always try to automate our team rules so that they don't rely on people who are then the guarantor of the respect of these rules.

Also explained in this video conference in french.

[![youtube video screenshot](https://img.youtube.com/vi/t36UqNSmybM/0.jpg)](https://www.youtube.com/watch?v=t36UqNSmybM)

With my colleague [Mickaël Alves](https://github.com/CruuzAzul), we took advantage of an R&D day to implement the rule _"Always add/modify tests when we make a fix or develop a new feature"_ that Florent was making sure we respected but with a Github action.

This is why we named the project `flo-du-bot`, linked to the name of the person who inspired this idea.

## Usage

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

Add this action on your pull request event workflows.

```yaml

steps:

  - uses: Slashgear/flo-du-bot@v1.0.0

    with:

      prTitlePattern: "(feat|fix)" # Regexp the title should match. (default)

      testFileExtensionPattern: "(spec.js|int.js|.feature|test.js)" # Regexp of modified files extensions (default)

      sourceFilePattern: "src/.*.(js|ts)" # Regexp of source files edition detection. (default)

      reviewEvent: "REQUEST_CHANGES" # Type of event triggered by the bot in the pullRequest (default) other values: COMMENT for review status comment, NONE if you don't want it to touch your PR reviews

      token: $ # Github token used (you could pass ${{ secrets.GITHUB_TOKEN }})

```

## 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/flo-du-bot/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)_