https://github.com/maximepremont/epitechcriterionactions

Simple GitHub action for Criterion unit tests at Epitech.
https://github.com/maximepremont/epitechcriterionactions

criterion epitech github-actions tests

Last synced: 4 months ago
JSON representation

Simple GitHub action for Criterion unit tests at Epitech.

• Host: GitHub
• URL: https://github.com/maximepremont/epitechcriterionactions
• Owner: MaximePremont
• License: gpl-3.0
• Created: 2021-10-28T11:22:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-21T09:39:04.000Z (about 2 years ago)
• Last Synced: 2023-03-07T11:23:45.914Z (almost 2 years ago)
• Topics: criterion, epitech, github-actions, tests
• Language: Python
• Homepage: https://github.com/MaximePremont/EpitechCriterionActions
• Size: 71.3 KB
• Stars: 10
• Watchers: 1
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
👨‍💻 Epitech Criterion Actions


Simple GitHub action for Criterion unit tests at Epitech


















## 🔍 Description

Epitech Criterion Actions is a GitHub action that will automatically launch the unit tests create with [Criterion](https://criterion.readthedocs.io/en/master/index.html) in the same way as the Epitech autocorrector. One the action is incorporated into the project, it will start when chages are sent to the main branch of the project. The results are formatted and sent to a special branch named "epitech-criterion-action" ( [see branch on example project](https://github.com/MaximePremont/EpitechCriterionActions_Example/tree/epitech-criterion-actions) )

## 💻 Example

### An example project has been created: [MaximePremont/EpitechCriterionActions_Example](https://github.com/MaximePremont/EpitechCriterionActions_Example)

![Example](./example.png?raw=true "Example")

README.md of epitech-criterion-actions branch


## ⚠️ Requirements

The criterion unit tests and the project must be organized as indecated in the epitech unit tests documentation.

#### The main points are :

* Have your Makefile at the root of the repository

* Have a "tests_run" rule that compiles the tests with `-lcriterion` and `--coverage`

* The test executable must be called "unit_tests"

* The test executable must not be deleted when calling "tests_run" in the makefile

> Do not hesitate to take a look at [the sample project](https://github.com/MaximePremont/EpitechCriterionActions_Example) to see how to correctly build your project and Makefile.

## 📝 Usage

Create a `.github/workflows/epitechcriterionactions.yaml` workflow file in your project repository :

```yaml

on:

  push:

    branches:

      - main

      - master

jobs:

  execute:

    runs-on: ubuntu-20.04

    steps:

      - uses: MaximePremont/EpitechCriterionActions@master

```

## 📄 Support

If you have any questions or problems, you can [create an issue](https://github.com/MaximePremont/EpitechCriterionActions/issues).

## 💡 Contributing

Do you have the slightest idea or do you want to develop the project? **Feel free to contribute !** For this a [contribution guide](./CONTRIBUTING.md) is available.

## 👤 You are an Epitech student ?  

Do not hesitate to use this GitHub Action for your projects and your reviews !

#### Don't forget to leave a star if the project was useful to you :star:

> [Epitech Criterion Actions](https://github.com/MaximePremont/EpitechCriterionActions) by [Maxime Premont](http://github.com/MaximePremont)