Skip to content

Docs: Add GitLab CI/CD to integrations. #13915

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.

Sign up for GitHub

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

Merged
MichaReiser merged 4 commits into from
Oct 26, 2024
Merged

Docs: Add GitLab CI/CD to integrations. #13915

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e8b1e96
Add GitLab CI/CD to integrations.
jvacek Oct 24, 2024
3642b91
pin version of ruff, clarify where to put snippet
jvacek Oct 24, 2024
3f7c029
Update docs/integrations.md
jvacek Oct 24, 2024
4b8add0
use build stage, split up, move up
jvacek Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/integrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,25 @@ In addition, ruff publishes the following images:

As with the distroless image, each image is published with ruff version tags as
`ruff:{major}.{minor}.{patch}-{base}` and `ruff:{major}.{minor}-{base}`, e.g., `ruff:0.6.6-alpine`.

## GitLab CI/CD

You can add the following configuration to `.gitlab-ci.yml` to run a `ruff format`, and a `ruff check` compatible with GitLab's codequality.

```yaml
Ruff:
stage: .pre
interruptible: true
image:
name: ghcr.io/astral-sh/ruff:0.7.1-alpine
Copy link
Member

@MichaReiser MichaReiser Oct 25, 2024

Choose a reason for hiding this comment

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

What's the motivation of using the docker image over using e.g. pip or uv pip to install the project's ruff version?
That would be more aligned with our GitHub Actions example

Copy link
Contributor Author

@jvacek jvacek Oct 25, 2024

Choose a reason for hiding this comment

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

It's way faster than installing ruff with pip every single time. That's one of the major advantages of the new images with extra tags you guys push.

Copy link
Member

@MichaReiser MichaReiser Oct 26, 2024

Choose a reason for hiding this comment

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

That makes sense. It does have the downside that they have to update the ruff version number locally in the project dependencies and CI. But I guess we can always add a second example if needed.

variables:
CODE_LOCATION: $CI_PROJECT_DIR
script:
- cd $CODE_LOCATION
- ruff --version
- ruff check --output-format=gitlab > code-quality-report.json
- ruff format --diff --verbose
artifacts:
reports:
codequality: $CODE_LOCATION/code-quality-report.json
```