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

Prepare CI / CD pipeline for initial release #76

Merged
merged 21 commits into from
Feb 28, 2022
Merged

Prepare CI / CD pipeline for initial release #76

merged 21 commits into from
Feb 28, 2022

Conversation

ChristophAlt
Copy link
Collaborator

@ChristophAlt ChristophAlt commented Feb 23, 2022

  • Add flake8 + some plugins for linting of code and docstrings
  • Add darglint for argument linting
  • Use nox for test automation (run tests against configured python versions and explicitly tests against installed package)
  • Remove unittesting from pre-commit
  • Make use of poetry mandatory to ensure the built and installed package is tested, not the source code
  • Add github workflows for test (code and documentation)
  • Add github workflow for release creating
  • Support Python 3.8 for now

Although this PR touches quite a few files, most of the changes are either additional configuration files or minor (automated) reformatting of code and other files.

Additional info:

@ArneBinder ArneBinder mentioned this pull request Feb 23, 2022
6 tasks
- add flake8 + plugins for linting
- add darglint for linting function signature and docstrings
- build docs with sphinx
- removed tests from pre-commit
- use nox + nox-poetry to run linting, tests, docs-build, docs-preview
- completed pyproject.toml
- add github workflows for tests and release
- change darglint to google style
- set prettier line-length to 99
- add tests and tests_not_slow to nox
darglint seems to have issues with parsing larger google-formated docstrings
@ChristophAlt ChristophAlt changed the title [WIP] Prepare CI / CD pipeline for initial release Prepare CI / CD pipeline for initial release Feb 24, 2022
Copy link
Owner

@ArneBinder ArneBinder left a comment

Choose a reason for hiding this comment

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

As far as I understand the changes, they look good. I have just two minor questions.

Also, could you create one/multiple further issues for the TODOs listed in "additional Info" of the PR description that we do not forget about this? I'm not really into linting/flake8 and don't know if this a single one or separate problems that's why I did not create them myself.

@ChristophAlt ChristophAlt merged commit a03c6db into main Feb 28, 2022
@ArneBinder ArneBinder deleted the ci_cd branch February 28, 2022 18:52
@ChristophAlt ChristophAlt added the ci Continuous Integration label Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants