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

Separate linting from unit-tests #2316

Closed
wants to merge 56 commits into from

Conversation

safoinme
Copy link
Contributor

@safoinme safoinme commented Jan 17, 2024

Describe changes

I implemented/fixed _ to achieve _.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

Summary by CodeRabbit

  • New Features
    • Introduced a new continuous integration job for enhanced linting on Ubuntu with Python 3.10.
  • Refactor
    • Updated GitHub Actions workflows to separate linting and unit testing concerns.
  • Chores
    • Removed draft pull request condition for linting workflow execution.
  • Bug Fixes
    • Fixed default settings in unit testing workflow for better integration with the environment setup.

strickvl and others added 17 commits January 11, 2024 18:13
…o/zenml into feature/OSSK-324-fast-ci-slow-ci
* give darglint check its own job

* fastCI

* add slowCI

* reenable fast CI

* remove comment

* add integration tests

* fix spellcheck context

* enable slow CI for testing

* remove unit test dependency

* fix dependency installations

* yamlfixed

* Comment-driven CI (#2275)

* test comment-driven approach

* delete unused test file

* slow CI is comment-driven

* restore CI

* conditionally respond to comments depending on team status

* add the whole team

* Update .github/workflows/ci-slow.yml

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>

* delete old CI

---------

Co-authored-by: Andrei Vishniakov <31008759+avishniakov@users.noreply.github.com>
Add custom-ubuntu-setup-and-unit-test workflow

Update unit-test workflow

Remove lint check from unit-test workflow
Copy link
Contributor

coderabbitai bot commented Jan 17, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Walkthrough

The project's GitHub workflows have been updated to separate linting from unit testing. A new job and workflow specific to linting on Ubuntu with Python 3.10 has been introduced, while the unit testing workflow no longer includes linting steps and has some default parameter adjustments. Debugging capabilities have been added to the linting workflow with tmate.

Changes

File Path Change Summary
.github/workflows/.../ci-fast.yml Added custom-ubuntu-setup-and-lint job for linting on PRs that are not drafts.
.github/workflows/linting.yml Created workflow for Python environment setup and linting with debug support via tmate.
.github/workflows/.../unit-test.yml Renamed workflow, changed install_zenml default to 'no', and removed linting and coverage upload comments.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Jan 17, 2024
@safoinme
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 3

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 8574802 and 7dfe336.
Files selected for processing (3)
  • .github/workflows/ci-fast.yml (1 hunks)
  • .github/workflows/linting.yml (1 hunks)
  • .github/workflows/unit-test.yml (3 hunks)
Additional comments: 2
.github/workflows/unit-test.yml (1)
  • 2-2: The workflow name has been updated to reflect the removal of the linting step.
.github/workflows/ci-fast.yml (1)
  • 51-62: A new job custom-ubuntu-setup-and-lint has been added to handle linting separately. Ensure that this job is correctly referenced and that the conditions for running it are appropriate.

.github/workflows/unit-test.yml Show resolved Hide resolved
Comment on lines 88 to 96
- name: Setup tmate session before tests
if: ${{ inputs.enable_tmate == 'before-tests' }}
uses: mxschmitt/action-tmate@v3.17
- name: Lint check
env:
OS: ${{ inputs.os }}
run: |
bash scripts/lint.sh
- name: Run unit tests
run: |
bash scripts/test-coverage-xml.sh unit

# - name: Upload coverage
# # only do it for python 3.8, we don't need to do it for every version
# if: ${{ inputs.os == 'ubuntu-dind-runners' && inputs.python-version == '3.8' }}
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The search for codecov/codecov-action within the .github/workflows/ directory indicates that the action is commented out in both unit-test.yml and linting.yml. This suggests that coverage uploading has been disabled in these workflows. There is no evidence from the provided output that coverage data is being uploaded in any other part of the workflow files.

Analysis chain

Note: This review was outside the patches, so it was mapped to the patch with the greatest overlap. Original lines [58-108]

The linting steps have been removed, and the comments related to uploading coverage have also been deleted. Ensure that coverage data is either not required anymore or is being handled elsewhere.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify that coverage uploading is handled in another workflow or is no longer needed.
rg --type yaml "codecov/codecov-action" .github/workflows/

Length of output: 204

.github/workflows/linting.yml Outdated Show resolved Hide resolved
strickvl and others added 7 commits January 18, 2024 09:08
* add pytest-shard dev dependency

* update script for sharded testing

* add ubuntu sharding

* fix naming

* Use `pytest-split` to shard CI (#2296)

* add split test to action

* Update user authentication logic

* Fix bug in login functionality

* Refactor test coverage script

* Update excluded directories in pyproject.toml

* Update integration test script to include shard number

* Update integration test script to use matrix.shard

* Update caching key in setup_environment action.yml

* Update durations path in test-coverage-xml.sh

* Update cache key in setup_environment action.yml

* Auto-update of Starter template

* Fix formatting issue in setup_environment action.yml

* Refactor code to improve performance and readability

---------

Co-authored-by: GitHub Actions <actions@github.com>

* Update pyproject.toml

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* add extra final line

* make workflows use normal ubuntu)

* fix durations path and update docstring

---------

Co-authored-by: Safoine El Khabich <34200873+safoinme@users.noreply.github.com>
Co-authored-by: GitHub Actions <actions@github.com>
Base automatically changed from feature/OSSK-324-fast-ci-slow-ci to develop January 23, 2024 14:39
@safoinme safoinme closed this Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants