Add tox.ini and GitHub workflow for running examples/validate.py #292
Conversation
This makes it easy to run the validation script locally as well as for all pushes and pull requests. The tox.ini file can also act as a platform for running other kinds of validations.
|
Just realized that I forgot to include copyright headers. Are they necessary in files like this? |
|
I can't say if it is really needed or not. I guess the general rule of thumb should be to include it wherever possible, but let's discuss that on TC. This page says it should be included wherever "applicable": https://github.com/eiffel-community/.github/blob/master/CONTRIBUTING.md#license-management, but that is up for interpretation. A list of file types or similar would probably be good to have there. |
|
There, copyright notices added. It's mildly distracting to have them there but we can live with it. If we ever reach a conclusion of what files actually require it we might find it fit to remove them again. |
…fel-community#292) This makes it easy to run the validation script locally as well as for all pushes and pull requests. The tox.ini file can also act as a platform for running other kinds of validations.
Applicable Issues
Fixes #265
Description of the Change
The addition of a tox.ini for running validate.py makes it easy to run the validation script locally and the new GitHub Actions workflow makes sure this is run for all pushes and pull requests. The tox.ini file can also act as a platform for running other kinds of validations that we might want to add in the future.
See https://github.com/magnusbaeck/eiffel/runs/4714406903 for an example of the workflow execution.
Alternate Designs
None.
Benefits
It'll be easier to run validate.py and the maintainers will get feedback in the PRs. And again, with this in place it'll be easier to add other forms of validation.
Possible Drawbacks
None.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Signed-off-by: Magnus Bäck <magnus.back@axis.com>