{"id":17359173,"url":"https://github.com/maximepremont/epitechcriterionactions","last_synced_at":"2025-08-24T06:46:00.102Z","repository":{"id":58594340,"uuid":"422175942","full_name":"MaximePremont/EpitechCriterionActions","owner":"MaximePremont","description":"Simple GitHub action for Criterion unit tests at Epitech.","archived":false,"fork":false,"pushed_at":"2022-11-21T09:39:04.000Z","size":73,"stargazers_count":12,"open_issues_count":4,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T12:11:08.296Z","etag":null,"topics":["criterion","epitech","github-actions","tests"],"latest_commit_sha":null,"homepage":"https://github.com/MaximePremont/EpitechCriterionActions","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MaximePremont.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-28T11:22:57.000Z","updated_at":"2025-03-27T08:29:20.000Z","dependencies_parsed_at":"2022-09-07T05:50:36.860Z","dependency_job_id":null,"html_url":"https://github.com/MaximePremont/EpitechCriterionActions","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximePremont%2FEpitechCriterionActions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximePremont%2FEpitechCriterionActions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximePremont%2FEpitechCriterionActions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MaximePremont%2FEpitechCriterionActions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MaximePremont","download_url":"https://codeload.github.com/MaximePremont/EpitechCriterionActions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981270,"owners_count":21193147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["criterion","epitech","github-actions","tests"],"created_at":"2024-10-15T19:08:28.325Z","updated_at":"2025-04-15T00:10:47.605Z","avatar_url":"https://github.com/MaximePremont.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e👨‍💻 Epitech Criterion Actions\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eSimple GitHub action for Criterion unit tests at Epitech\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"./LICENCE\"\u003e\u003cimg alt=\"License\" src=\"https://img.shields.io/badge/License-GPLv3-blue.svg\" /\u003e\u003ca\u003e\n\u003ca href=\"https://github.com/MaximePremont/EpitechCriterionActions/issues\"\u003e\u003cimg alt=\"issues\" src=\"https://badgen.net/github/issues/MaximePremont/EpitechCriterionActions\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/MaximePremont/EpitechCriterionActions\"\u003e\u003cimg alt=\"PRs\" src=\"https://badgen.net/github/prs/MaximePremont/EpitechCriterionActions\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/MaximePremont/EpitechCriterionActions\"\u003e\u003cimg alt=\"Open Source\" src=\"https://badges.frapsoft.com/os/v1/open-source.svg?v=103\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/MaximePremont/EpitechCriterionActions/network/members\"\u003e\u003cimg alt=\"forks\" src=\"https://badgen.net/github/forks/MaximePremont/EpitechCriterionActions\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/MaximePremont/EpitechCriterionActions\"\u003e\u003cimg alt=\"stars\" src=\"https://badgen.net/github/stars/MaximePremont/EpitechCriterionActions\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## 🔍 Description\n\nEpitech 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) )\n\n## 💻 Example\n\n### An example project has been created: [MaximePremont/EpitechCriterionActions_Example](https://github.com/MaximePremont/EpitechCriterionActions_Example)\n![Example](./example.png?raw=true \"Example\")\n\u003cp align=\"center\"\u003eREADME.md of epitech-criterion-actions branch\u003c/p\u003e\n\n## ⚠️ Requirements\n\nThe criterion unit tests and the project must be organized as indecated in the epitech unit tests documentation.\n#### The main points are :\n* Have your Makefile at the root of the repository\n* Have a \"tests_run\" rule that compiles the tests with `-lcriterion` and `--coverage`\n* The test executable must be called \"unit_tests\"\n* The test executable must not be deleted when calling \"tests_run\" in the makefile\n\u003e 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.\n\n## 📝 Usage\n\nCreate a `.github/workflows/epitechcriterionactions.yaml` workflow file in your project repository :\n```yaml\non:\n  push:\n    branches:\n      - main\n      - master\njobs:\n  execute:\n    runs-on: ubuntu-20.04\n    steps:\n      - uses: MaximePremont/EpitechCriterionActions@master\n```\n\n## 📄 Support\n\nIf you have any questions or problems, you can [create an issue](https://github.com/MaximePremont/EpitechCriterionActions/issues).\n\n## 💡 Contributing\n\n\nDo 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.\n\n\n## 👤 You are an Epitech student ?  \n\nDo not hesitate to use this GitHub Action for your projects and your reviews !\n\n#### Don't forget to leave a star if the project was useful to you :star:\n\n\n\u003e [Epitech Criterion Actions](https://github.com/MaximePremont/EpitechCriterionActions) by [Maxime Premont](http://github.com/MaximePremont)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaximepremont%2Fepitechcriterionactions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaximepremont%2Fepitechcriterionactions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaximepremont%2Fepitechcriterionactions/lists"}