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

ci: reformat, reset branches & upgrade actions #30

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Karanjot786
Copy link
Member

@Karanjot786 Karanjot786 commented Oct 4, 2024

CI - Reformat, Reset Branches & Upgrade Actions

Objective

Upgrade and reformat the CI pipeline without adding unnecessary jobs (such as unit tests).

Changes

  • Upgraded CI actions, such as actions/checkout and actions/setup-python, to their latest versions (v4).
  • Removed commented-out code and unnecessary jobs from .github/workflows/ci.yml.
  • Reformatted and simplified the CI workflow.

Related Files

  • .github/workflows/ci.yml: Focused only on upgrading actions and reformatting the existing workflow. No unit test jobs have been added at this stage.

Summary by Sourcery

Upgrade and reformat the CI pipeline by updating actions to their latest versions, removing unnecessary code, and simplifying the workflow configuration.

CI:

  • Upgrade CI actions to the latest versions, including 'actions/checkout' to v4 and 'actions/setup-python' to v4.
  • Remove commented-out code and unnecessary jobs from the CI workflow configuration.
  • Reformat and simplify the CI workflow, ensuring it runs on all branches instead of just 'main'.

Copy link

sourcery-ai bot commented Oct 4, 2024

Reviewer's Guide by Sourcery

This pull request focuses on upgrading and reformatting the CI pipeline without adding new jobs. The main changes include upgrading CI actions to their latest versions, removing unnecessary code, and simplifying the workflow structure in the .github/workflows/ci.yml file.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Upgrade CI actions to latest versions
  • Upgraded actions/checkout from v2 to v4
  • Upgraded actions/setup-python from v2 to v4
.github/workflows/ci.yml
Expand branch coverage for CI workflow
  • Changed push and pull_request triggers to run on all branches ('*') instead of just 'main'
.github/workflows/ci.yml
Simplify and clean up CI workflow structure
  • Removed commented-out test job
  • Adjusted indentation for better readability
  • Added conditional execution for Ruff linting step
.github/workflows/ci.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Karanjot786 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider being more specific with the branch triggers instead of using '*'. This might cause unnecessary workflow runs.
  • The 'Run tests' step is still commented out. If tests exist, consider including them in the CI process for better code quality assurance.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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