diff --git a/README.md b/README.md index e26e41e4a3a94514c4ccf5df1b1e75ee58b85fb3..d5ec52d896551db028b4bcca5b3d6fb9b0926d4f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,32 @@ -# Python Ruff +# Ruff Docker Image -Docker image for python with Ruff installed +[](https://docs.astral.sh/ruff/) +[](https://lab.frogg.it/swepy/containers/ruff/-/pipelines?ref=main) +[](https://lab.frogg.it/swepy/cicd-templates/ruff-docker-image/-/blob/main/LICENSE) + +[](https://lab.frogg.it/swepy/containers/ruff) +[](https://gitlab.com/swepy/containers/ruff) + +This Docker image provides a ready-to-use environment with Ruff installed. Ruff is a +highly efficient Python linter and code formatter that significantly speeds up code +checking and formatting tasks. Built with Rust, Ruff offers performance that is orders +of magnitude faster than traditional tools +like [Flake8](https://flake8.pycqa.org/en/latest/) +or [Black](https://black.readthedocs.io/en/stable/index.html). + +## Security + +### All versions + +[CVE-2018-20225â ](https://scout.docker.com/vulnerabilities/id/CVE-2018-20225): This only +affects use of the --extra-index-url option, which is not used to install ruff in the +image. + +## CICD + +We rely on GitLab CI components to build and release this image: + +[](https://gitlab.com/explore/catalog/swepy/cicd-templates/release-by-changelog) +[](https://gitlab.com/explore/catalog/swepy/cicd-templates/docker-build) +[](https://gitlab.com/explore/catalog/swepy/cicd-templates/pypi-to-docker-missing-version) +[](https://github.com/GoogleContainerTools/kaniko)