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: switch from Gitlab to Github #1

Merged
merged 3 commits into from
Dec 6, 2024
Merged

CI: switch from Gitlab to Github #1

merged 3 commits into from
Dec 6, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Dec 6, 2024

Switch the CI pipeline from Gitlab to Github.

Summary by Sourcery

CI:

  • Switch the CI pipeline from Gitlab to Github by adding multiple Github Actions workflows for publishing, testing, documentation, and linting.

Copy link

sourcery-ai bot commented Dec 6, 2024

Reviewer's Guide by Sourcery

The PR migrates the CI/CD pipeline from GitLab to GitHub Actions. It implements four distinct workflows: testing, documentation building, linting, and publishing. The publishing workflow is triggered by version tags and handles PyPI package publishing, documentation deployment to GitHub Pages, and GitHub release creation. The test workflow runs on multiple platforms (Ubuntu, macOS, Windows) with Python 3.10, while documentation and linting workflows run on Ubuntu.

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

File-Level Changes

Change Details Files
Implemented GitHub Actions workflow for testing across multiple platforms
  • Set up matrix testing for Ubuntu, macOS, and Windows
  • Configures Python 3.10 environment
  • Installs package and test requirements
  • Runs pytest for testing
  • Uploads coverage reports to Codecov (Ubuntu only)
.github/workflows/test.yml
Created comprehensive publishing workflow for releases
  • Triggers on version tags (v*)
  • Builds and publishes Python package to PyPI
  • Builds and deploys documentation to GitHub Pages
  • Creates GitHub releases with changelog entries
  • Handles dependency installation including system packages
.github/workflows/publish.yml
Added documentation building workflow
  • Builds documentation using Sphinx
  • Performs link checking in documentation
  • Runs on Ubuntu with Python 3.10
.github/workflows/doc.yml
Implemented code quality checks workflow
  • Sets up pre-commit hooks
  • Runs code style checks on all files
.github/workflows/linter.yml
Removed GitLab CI configuration
  • Deleted GitLab CI configuration file
.gitlab-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.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

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 @hagenw - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please provide more context in the PR description about why this migration from GitLab CI to GitHub Actions is being made. What are the benefits or motivations for this change?
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.

@hagenw hagenw merged commit 727554f into main Dec 6, 2024
5 checks passed
@hagenw hagenw deleted the add-tests branch December 6, 2024 09:15
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.

1 participant