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

Add linter checks and unit testing to Github Workflow. #38

Merged
merged 22 commits into from
Nov 28, 2023

Conversation

LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Nov 27, 2023

Description

Before this PR, GitHub workflow does not enforce linter checks and unit testing. This PR adds support to enhance our current GitHub workflow.
Changes made:

  1. Add a job in the current workflow to execute linter checks, including docformatter, black, ruff, and mypy. clang-tidy is not included because it cannot be installed through pip.
  2. Add setup.cfg to specify project dependencies. This is required for Python3.6 because pyproject.toml started being supported from Python3.7.
  3. Update linters to the latest released version with formatting changes to the current code. There are some unexpected behaviors detected in clang-format. After discussing with @kirkrodrigues we decided to leave what it is for now, but I have fired an issue to clang-format to see if they can help fix it.
  4. Configure the cibuildwheel to execute unit tests for the built wheels under the target environment (platform and architecture). The configure is specified in pyproject.toml. Detailed doc can be found here. Notice that currently only Python3.6, Python3.8, and Python3.11 are tested.

@LinZhihao-723 LinZhihao-723 changed the title Improve Github Workflow to enforce linter checks and unit testing Add support to Github Workflow to enforce linter checks and unit testing Nov 27, 2023
@LinZhihao-723 LinZhihao-723 changed the title Add support to Github Workflow to enforce linter checks and unit testing Add linter checks and unit testing to Github Workflow. Nov 28, 2023
@LinZhihao-723 LinZhihao-723 merged commit 3521c73 into y-scope:main Nov 28, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants