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

Use tox and pre-commit for testing #221

Merged
merged 5 commits into from
Jan 3, 2021
Merged

Conversation

roaldnefs
Copy link
Member

Use tox and pre-commit for testing to allow users to locally test by only having to install those two dependencies.

This commit also simplifies and merges the GitHub workflows build and lint, as they are now two steps in the tox worflow.

Use `tox` and `pre-commit` for testing to allow users to locally test by
only having to install those two dependencies.

This commit also simplifies and merges the GitHub workflows `build` and
`lint`, as they are now two steps in the `tox` worflow.

Signed-off-by: Roald Nefs <info@roaldnefs.com>
@roaldnefs roaldnefs added Type: Enhancement New feature or request Priority: Low labels Jan 3, 2021
Signed-off-by: Roald Nefs <info@roaldnefs.com>
Signed-off-by: Roald Nefs <info@roaldnefs.com>
Signed-off-by: Roald Nefs <info@roaldnefs.com>
Signed-off-by: Roald Nefs <info@roaldnefs.com>
@roaldnefs roaldnefs requested a review from jbouter January 3, 2021 10:24
Copy link
Member

@jbouter jbouter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant work! Thanks. Should we start including documentation specifically on how to contribute and set up a dev environment for salt-lint? I feel there's a growing amount of specifics. I reckon pre-commit hooks aren't going to magically work on their own.

@roaldnefs
Copy link
Member Author

Brilliant work! Thanks. Should we start including documentation specifically on how to contribute and set up a dev environment for salt-lint? I feel there's a growing amount of specifics. I reckon pre-commit hooks aren't going to magically work on their own.

I suppose we should indeed start to write some documentation about how to contribute to salt-lint. I'm thinking about adding a docs directory and using Sphinx to automatically generated the documentation. This would allow the removal/deprecation of the GitHub wiki, thus making it possible to include any required documentation in a pull request instead of having to manually add it after the pull request has been merged.

@roaldnefs roaldnefs merged commit 5b1d330 into warpnet:develop Jan 3, 2021
@roaldnefs roaldnefs deleted the use-tox branch January 3, 2021 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants