mirror of
https://github.com/astral-sh/ruff.git
synced 2026-11-22 17:43:09 +08:00
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/download-artifact](https://redirect.github.com/actions/download-artifact) | action | patch | `v8.0.1` → `v8.0.2` | | [actions/upload-artifact](https://redirect.github.com/actions/upload-artifact) | action | patch | `v7.0.1` → `v7.0.2` | --- > [!WARNING] > Some dependencies could not be looked up. Check the [Dependency Dashboard](../issues/10578) for more information. --- ### Release Notes <details> <summary>actions/download-artifact</summary> ### [`v8.0.2`](https://redirect.github.com/actions/download-artifact/releases/tag/v8.0.2) [Compare Source](https://redirect.github.com/actions/download-artifact/compare/v8.0.1...v8.0.2) #### What's Changed - Update the readme by [@​danwkennedy](https://redirect.github.com/danwkennedy) in [#​473](https://redirect.github.com/actions/download-artifact/pull/473) - Improves artifact download retries when the service returns HTTP 429 (rate limiting), including honoring valid Retry-After headers. - Update [@​actions/artifact](https://redirect.github.com/actions/artifact) to 6.3.1 by [@​tunc-d](https://redirect.github.com/tunc-d) in [#​492](https://redirect.github.com/actions/download-artifact/pull/492) - Prepare download-artifact v8.0.2 by [@​tunc-d](https://redirect.github.com/tunc-d) in [#​493](https://redirect.github.com/actions/download-artifact/pull/493) #### New Contributors - [@​tunc-d](https://redirect.github.com/tunc-d) made their first contribution in [#​492](https://redirect.github.com/actions/download-artifact/pull/492) **Full Changelog**: <https://github.com/actions/download-artifact/compare/v8.0.1...v8.0.2> </details> <details> <summary>actions/upload-artifact</summary> ### [`v7.0.2`](https://redirect.github.com/actions/upload-artifact/releases/tag/v7.0.2) [Compare Source](https://redirect.github.com/actions/upload-artifact/compare/v7.0.1...v7.0.2) #### What's Changed - Improves artifact download retries when the service returns HTTP 429 (rate limiting), including honoring valid Retry-After headers. - Updates [@​actions/artifact](https://redirect.github.com/actions/artifact) to v6.3.1. #### New Contributors - [@​tunc-d](https://redirect.github.com/tunc-d) made their first contribution in [#​821](https://redirect.github.com/actions/upload-artifact/pull/821) **Full Changelog**: <https://github.com/actions/upload-artifact/compare/v7.0.1...v7.0.2> </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - "before 4am on Wednesday" - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://redirect.github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/astral-sh/ruff). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC4yMjIuNSIsInVwZGF0ZWRJblZlciI6IjQ0LjIyMi41IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJpbnRlcm5hbCJdfQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
375 lines
15 KiB
YAML
375 lines
15 KiB
YAML
# Build and publish a Docker image.
|
|
#
|
|
# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a local
|
|
# artifacts job within `cargo-dist`.
|
|
#
|
|
# TODO(charlie): Ideally, the publish step would happen as a publish job within `cargo-dist`, but
|
|
# sharing the built image as an artifact between jobs is challenging.
|
|
name: "[ruff] Build Docker image"
|
|
|
|
on:
|
|
workflow_call:
|
|
inputs:
|
|
plan:
|
|
required: true
|
|
type: string
|
|
pull_request:
|
|
paths:
|
|
- .github/workflows/build-docker.yml
|
|
- Dockerfile
|
|
|
|
env:
|
|
UV_LOCKED: 1
|
|
ACTIONS_CACHE_MODE: none
|
|
RUFF_BASE_IMG: ghcr.io/${{ github.repository_owner }}/ruff
|
|
|
|
permissions:
|
|
contents: read
|
|
# TODO(zanieb): Ideally, this would be `read` on dry-run but that will require
|
|
# significant changes to the workflow.
|
|
packages: write # zizmor: ignore[excessive-permissions]
|
|
|
|
jobs:
|
|
docker-build:
|
|
name: Build Docker image (ghcr.io/astral-sh/ruff) for ${{ matrix.platform }}
|
|
runs-on: ${{ github.repository == 'astral-sh/ruff' && 'github-ubuntu-24.04-x86_64-4' || 'ubuntu-latest' }}
|
|
environment:
|
|
name: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit && 'release' || '' }}
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
platform:
|
|
- linux/amd64
|
|
- linux/arm64
|
|
steps:
|
|
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
with:
|
|
submodules: recursive
|
|
persist-credentials: false
|
|
|
|
- uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
|
|
|
- uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
|
if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
with:
|
|
registry: ghcr.io
|
|
username: ${{ github.repository_owner }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Check tag consistency
|
|
if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
env:
|
|
TAG: ${{ inputs.plan != '' && fromJson(inputs.plan).announcement_tag || 'dry-run' }}
|
|
run: |
|
|
version=$(grep -m 1 "^version = " pyproject.toml | sed -e 's/version = "\(.*\)"/\1/g')
|
|
if [ "${TAG}" != "${version}" ]; then
|
|
echo "The input tag does not match the version from pyproject.toml:" >&2
|
|
echo "${TAG}" >&2
|
|
echo "${version}" >&2
|
|
exit 1
|
|
else
|
|
echo "Releasing ${version}"
|
|
fi
|
|
|
|
- name: Extract metadata (tags, labels) for Docker
|
|
id: meta
|
|
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
|
|
with:
|
|
images: ${{ env.RUFF_BASE_IMG }}
|
|
# Defining this makes sure the org.opencontainers.image.version OCI label becomes the actual release version and not the branch name
|
|
tags: |
|
|
type=raw,value=dry-run,enable=${{ inputs.plan == '' || fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
type=pep440,pattern={{ version }},value=${{ inputs.plan != '' && fromJson(inputs.plan).announcement_tag || 'dry-run' }},enable=${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
|
|
- name: Normalize Platform Pair (replace / with -)
|
|
run: |
|
|
platform=${{ matrix.platform }}
|
|
echo "PLATFORM_TUPLE=${platform//\//-}" >> "$GITHUB_ENV"
|
|
|
|
# Adapted from https://docs.docker.com/build/ci/github-actions/multi-platform/
|
|
- name: Build and push by digest
|
|
id: build
|
|
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
|
|
with:
|
|
context: .
|
|
platforms: ${{ matrix.platform }}
|
|
labels: ${{ steps.meta.outputs.labels }}
|
|
outputs: type=image,name=${{ env.RUFF_BASE_IMG }},push-by-digest=true,name-canonical=true,push=${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
|
|
- name: Export digests
|
|
env:
|
|
digest: ${{ steps.build.outputs.digest }}
|
|
run: |
|
|
mkdir -p /tmp/digests
|
|
touch "/tmp/digests/${digest#sha256:}"
|
|
|
|
- name: Upload digests
|
|
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
with:
|
|
name: digests-${{ env.PLATFORM_TUPLE }}
|
|
path: /tmp/digests/*
|
|
if-no-files-found: error
|
|
retention-days: 1
|
|
|
|
docker-publish:
|
|
name: Publish Docker image (ghcr.io/astral-sh/ruff)
|
|
runs-on: ${{ github.repository == 'astral-sh/ruff' && 'github-ubuntu-24.04-x86_64-4' || 'ubuntu-latest' }}
|
|
environment:
|
|
name: release
|
|
needs:
|
|
- docker-build
|
|
if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
permissions:
|
|
attestations: write
|
|
id-token: write
|
|
packages: write
|
|
steps:
|
|
- uses: $/.github/actions/setup-ruff-workspace
|
|
with:
|
|
group: jaq
|
|
|
|
- name: Download digests
|
|
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
|
with:
|
|
path: /tmp/digests
|
|
pattern: digests-*
|
|
merge-multiple: true
|
|
|
|
- uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
|
|
|
- name: Extract metadata (tags, labels) for Docker
|
|
id: meta
|
|
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
|
|
with:
|
|
images: ${{ env.RUFF_BASE_IMG }}
|
|
# Order is on purpose such that the label org.opencontainers.image.version has the first pattern with the full version
|
|
tags: |
|
|
type=pep440,pattern={{ version }},value=${{ fromJson(inputs.plan).announcement_tag }}
|
|
type=pep440,pattern={{ major }}.{{ minor }},value=${{ fromJson(inputs.plan).announcement_tag }}
|
|
|
|
- uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
|
with:
|
|
registry: ghcr.io
|
|
username: ${{ github.repository_owner }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
# Adapted from https://docs.docker.com/build/ci/github-actions/multi-platform/
|
|
- name: Create manifest list and push
|
|
working-directory: /tmp/digests
|
|
# The jaq command expands the docker/metadata json "tags" array entry to `-t tag1 -t tag2 ...` for each tag in the array
|
|
# The printf will expand the base image with the `<RUFF_BASE_IMG>@sha256:<sha256> ...` for each sha256 in the directory
|
|
# The final command becomes `docker buildx imagetools create -t tag1 -t tag2 ... <RUFF_BASE_IMG>@sha256:<sha256_1> <RUFF_BASE_IMG>@sha256:<sha256_2> ...`
|
|
run: |
|
|
# shellcheck disable=SC2046
|
|
docker buildx imagetools create \
|
|
$(jaq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
|
|
$(printf "${RUFF_BASE_IMG}@sha256:%s " *)
|
|
|
|
- name: Export manifest digest
|
|
id: manifest-digest
|
|
env:
|
|
IMAGE: ${{ env.RUFF_BASE_IMG }}
|
|
VERSION: ${{ steps.meta.outputs.version }}
|
|
run: |
|
|
digest="$(
|
|
docker buildx imagetools inspect \
|
|
"${IMAGE}:${VERSION}" \
|
|
--format '{{json .Manifest}}' \
|
|
| jaq -r '.digest'
|
|
)"
|
|
echo "digest=${digest}" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Generate artifact attestation
|
|
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4.2.2
|
|
with:
|
|
subject-name: ${{ env.RUFF_BASE_IMG }}
|
|
subject-digest: ${{ steps.manifest-digest.outputs.digest }}
|
|
|
|
docker-publish-extra:
|
|
name: Publish additional Docker image based on ${{ matrix.image-mapping }}
|
|
runs-on: ${{ github.repository == 'astral-sh/ruff' && 'github-ubuntu-24.04-x86_64-4' || 'ubuntu-latest' }}
|
|
environment:
|
|
name: release
|
|
needs:
|
|
- docker-publish
|
|
if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
permissions:
|
|
attestations: write
|
|
id-token: write
|
|
packages: write
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
# Mapping of base image followed by a comma followed by one or more base tags (comma separated)
|
|
# Note, org.opencontainers.image.version label will use the first base tag (use the most specific tag first)
|
|
image-mapping:
|
|
- alpine:3.23,alpine3.23,alpine
|
|
- debian:trixie-slim,trixie-slim,debian-slim
|
|
- buildpack-deps:trixie,trixie,debian
|
|
steps:
|
|
- uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
|
|
|
- uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
|
with:
|
|
registry: ghcr.io
|
|
username: ${{ github.repository_owner }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Generate Dynamic Dockerfile Tags
|
|
shell: bash
|
|
env:
|
|
TAG_VALUE: ${{ fromJson(inputs.plan).announcement_tag }}
|
|
run: |
|
|
set -euo pipefail
|
|
|
|
# Extract the image and tags from the matrix variable
|
|
IFS=',' read -r BASE_IMAGE BASE_TAGS <<< "${{ matrix.image-mapping }}"
|
|
|
|
# Generate Dockerfile content
|
|
cat <<EOF > Dockerfile
|
|
FROM ${BASE_IMAGE}
|
|
COPY --from=${RUFF_BASE_IMG}:latest /ruff /usr/local/bin/ruff
|
|
ENTRYPOINT []
|
|
CMD ["/usr/local/bin/ruff"]
|
|
EOF
|
|
|
|
# Initialize a variable to store all tag docker metadata patterns
|
|
TAG_PATTERNS=""
|
|
|
|
# Loop through all base tags and append its docker metadata pattern to the list
|
|
# Order is on purpose such that the label org.opencontainers.image.version has the first pattern with the full version
|
|
IFS=','; for TAG in ${BASE_TAGS}; do
|
|
TAG_PATTERNS="${TAG_PATTERNS}type=pep440,pattern={{ version }},suffix=-${TAG},value=${TAG_VALUE}\n"
|
|
TAG_PATTERNS="${TAG_PATTERNS}type=pep440,pattern={{ major }}.{{ minor }},suffix=-${TAG},value=${TAG_VALUE}\n"
|
|
TAG_PATTERNS="${TAG_PATTERNS}type=raw,value=${TAG}\n"
|
|
done
|
|
|
|
# Remove the trailing newline from the pattern list
|
|
TAG_PATTERNS="${TAG_PATTERNS%\\n}"
|
|
|
|
# Export image cache name
|
|
echo "IMAGE_REF=${BASE_IMAGE//:/-}" >> "$GITHUB_ENV"
|
|
|
|
# Export tag patterns using the multiline env var syntax
|
|
{
|
|
echo "TAG_PATTERNS<<EOF"
|
|
echo -e "${TAG_PATTERNS}"
|
|
echo EOF
|
|
} >> "$GITHUB_ENV"
|
|
|
|
- name: Extract metadata (tags, labels) for Docker
|
|
id: meta
|
|
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
|
|
# ghcr.io prefers index level annotations
|
|
env:
|
|
DOCKER_METADATA_ANNOTATIONS_LEVELS: index
|
|
with:
|
|
images: ${{ env.RUFF_BASE_IMG }}
|
|
flavor: |
|
|
latest=false
|
|
tags: |
|
|
${{ env.TAG_PATTERNS }}
|
|
|
|
- name: Build and push
|
|
id: build-and-push
|
|
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
|
|
with:
|
|
context: .
|
|
platforms: linux/amd64,linux/arm64
|
|
# We do not really need to cache here as the Dockerfile is tiny
|
|
#cache-from: type=gha,scope=ruff-${{ env.IMAGE_REF }}
|
|
#cache-to: type=gha,mode=min,scope=ruff-${{ env.IMAGE_REF }}
|
|
push: true
|
|
tags: ${{ steps.meta.outputs.tags }}
|
|
labels: ${{ steps.meta.outputs.labels }}
|
|
annotations: ${{ steps.meta.outputs.annotations }}
|
|
|
|
- name: Generate artifact attestation
|
|
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4.2.2
|
|
with:
|
|
subject-name: ${{ env.RUFF_BASE_IMG }}
|
|
subject-digest: ${{ steps.build-and-push.outputs.digest }}
|
|
|
|
# This is effectively a duplicate of `docker-publish` to make https://github.com/astral-sh/ruff/pkgs/container/ruff
|
|
# show the ruff base image first since GitHub always shows the last updated image digests
|
|
# This works by annotating the original digests (previously non-annotated) which triggers an update to ghcr.io
|
|
docker-republish:
|
|
name: Annotate Docker image (ghcr.io/astral-sh/ruff)
|
|
runs-on: ${{ github.repository == 'astral-sh/ruff' && 'github-ubuntu-24.04-x86_64-4' || 'ubuntu-latest' }}
|
|
environment:
|
|
name: release
|
|
needs:
|
|
- docker-publish-extra
|
|
if: ${{ inputs.plan != '' && !fromJson(inputs.plan).announcement_tag_is_implicit }}
|
|
permissions:
|
|
attestations: write
|
|
id-token: write
|
|
packages: write
|
|
steps:
|
|
- uses: $/.github/actions/setup-ruff-workspace
|
|
with:
|
|
group: jaq
|
|
|
|
- name: Download digests
|
|
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
|
with:
|
|
path: /tmp/digests
|
|
pattern: digests-*
|
|
merge-multiple: true
|
|
|
|
- uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
|
|
|
- name: Extract metadata (tags, labels) for Docker
|
|
id: meta
|
|
uses: docker/metadata-action@dc802804100637a589fabce1cb79ff13a1411302 # v6.2.0
|
|
env:
|
|
DOCKER_METADATA_ANNOTATIONS_LEVELS: index
|
|
with:
|
|
images: ${{ env.RUFF_BASE_IMG }}
|
|
# Order is on purpose such that the label org.opencontainers.image.version has the first pattern with the full version
|
|
tags: |
|
|
type=pep440,pattern={{ version }},value=${{ fromJson(inputs.plan).announcement_tag }}
|
|
type=pep440,pattern={{ major }}.{{ minor }},value=${{ fromJson(inputs.plan).announcement_tag }}
|
|
|
|
- uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
|
with:
|
|
registry: ghcr.io
|
|
username: ${{ github.repository_owner }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
# Adapted from https://docs.docker.com/build/ci/github-actions/multi-platform/
|
|
- name: Create manifest list and push
|
|
working-directory: /tmp/digests
|
|
# The readarray part is used to make sure the quoting and special characters are preserved on expansion (e.g. spaces)
|
|
# The jaq command expands the docker/metadata json "tags" array entry to `-t tag1 -t tag2 ...` for each tag in the array
|
|
# The printf will expand the base image with the `<RUFF_BASE_IMG>@sha256:<sha256> ...` for each sha256 in the directory
|
|
# The final command becomes `docker buildx imagetools create -t tag1 -t tag2 ... <RUFF_BASE_IMG>@sha256:<sha256_1> <RUFF_BASE_IMG>@sha256:<sha256_2> ...`
|
|
run: |
|
|
readarray -t lines <<< "$DOCKER_METADATA_OUTPUT_ANNOTATIONS"; annotations=(); for line in "${lines[@]}"; do annotations+=(--annotation "$line"); done
|
|
|
|
# shellcheck disable=SC2046
|
|
docker buildx imagetools create \
|
|
"${annotations[@]}" \
|
|
$(jaq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
|
|
$(printf "${RUFF_BASE_IMG}@sha256:%s " *)
|
|
|
|
- name: Export manifest digest
|
|
id: manifest-digest
|
|
env:
|
|
IMAGE: ${{ env.RUFF_BASE_IMG }}
|
|
VERSION: ${{ steps.meta.outputs.version }}
|
|
run: |
|
|
digest="$(
|
|
docker buildx imagetools inspect \
|
|
"${IMAGE}:${VERSION}" \
|
|
--format '{{json .Manifest}}' \
|
|
| jaq -r '.digest'
|
|
)"
|
|
echo "digest=${digest}" >> "$GITHUB_OUTPUT"
|
|
|
|
- name: Generate artifact attestation
|
|
uses: actions/attest@1e69f48acb82d1966a394da916b4c1698aa569d6 # v4.2.2
|
|
with:
|
|
subject-name: ${{ env.RUFF_BASE_IMG }}
|
|
subject-digest: ${{ steps.manifest-digest.outputs.digest }}
|