Skip to content

Conversation

@LuigiGiuffrida98
Copy link
Member

@LuigiGiuffrida98 LuigiGiuffrida98 commented Mar 11, 2024

Description

This PR aims to setup a basic CI for the development of len5 core.

Two jobs are added:

  1. format-lint EXECUTED ON EVERY PUSH (execute make lint && make format) runs the linting and formatting of the code
  2. sanity-check EXECUTED ONLY ON PRs (execute make check) runs the simulation of the test applications and compares the trace with SPIKE simulation

The CI is run on github runners with the len5-docker-ci.

⚠️ To avoid the execution of the sanity check on WIP PR set them as draft, then, when they are ready mark them as ready (this will reduce a bit the carbon footprint of github servers :octocat: ❤️ 🍃 and most importantly will reduce the amount of emails received by our beloved maintainers 👨‍💻 👩‍💻 ❤️)

Status

Waiting for fixes and update to the SPIKE simulation flow to merge, at the current state the CI is up and running fine

TODO

  • Setup the CI scripts
  • Protect the main branch? (@StMiky you decide)
  • Update the README and the CONTRIBUTING guidelines
  • Lint and format should produce a new commit? (@StMiky you decide)
  • The individual checks are executed as sub-steps of the sanity check job to have a more useful and informative output on github actions page

Funny/good to have TODO

  • Add badges in the readme according to CI results

@StMiky StMiky self-assigned this Mar 12, 2024
@StMiky
Copy link
Contributor

StMiky commented Mar 12, 2024

To be merged after the Spike check overhaul by @mattiamirigaldi .

@StMiky StMiky added the enhancement New feature or request label Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants