Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint YAML and Python files on CI #114

Closed
MattiSG opened this issue Aug 9, 2021 · 2 comments · Fixed by #115
Closed

Lint YAML and Python files on CI #114

MattiSG opened this issue Aug 9, 2021 · 2 comments · Fixed by #115
Assignees
Labels
kind:style Changes that do not affect the meaning of the code

Comments

@MattiSG
Copy link
Member

MattiSG commented Aug 9, 2021

OpenFisca-France has tests to automatically lint YAML and Python files.

I believe the publishing process is already part of the OpenFisca Country Template suggestions, and that maintaining consistent quality and syntax is a meaningful way to ease contribution.

I thus suggest importing these tests, alongside any other improvements made to the testing procedure, to the Country Template (probably toning down a bit the tongue-in-cheek phrasings 😉).

Opinions welcome @openfisca/international-contrib!

@HAEKADI
Copy link
Contributor

HAEKADI commented Sep 1, 2021

@MattiSG Should we only add the linting job, or restructure the entire CircleCI configuration like we did with OpenFisca France here?

The restructuring would include amongst other things:

  • Separating the install from the build
  • Separating the buildand the test
  • Using openfisca test instead of make test, which does check for syntax errors and does some linting as well
  • Adding a separate job which lints Python and YAML files
  • Changing the job dependencies in the workflow

@MattiSG
Copy link
Member Author

MattiSG commented Sep 1, 2021

Yes, and we should also switch to GitHub Actions as agreed on openfisca/openfisca-core#1030 😉
This issue is only about adding linting. It can be closed alongside others if a larger PR is open on that topic 🙂

@bonjourmauko bonjourmauko added the kind:style Changes that do not affect the meaning of the code label Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:style Changes that do not affect the meaning of the code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants