rustfs/.github/workflows/helm-package.yml

# Copyright 2024 RustFS Team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Publish helm chart to artifacthub

on:
  workflow_run:
    workflows: [ "Build and Release" ]
    types: [ completed ]
  workflow_dispatch:
    inputs:
      version:
        description: "Release version to publish, e.g. 1.0.0-beta.1 or v1.0.0-beta.1"
        required: true
        default: "1.0.0-beta.1"
        type: string

permissions:
  contents: read

jobs:
  build-helm-package:
    runs-on: sm-standard-2
    timeout-minutes: 30
    if: |
      (github.event_name == 'workflow_dispatch' && !contains(github.event.inputs.version, '-preview')) ||
      (
        github.event.workflow_run.conclusion == 'success' &&
        github.event.workflow_run.event == 'push' &&
        contains(github.event.workflow_run.head_branch, '.') &&
        !contains(github.event.workflow_run.head_branch, '-preview')
      )

    outputs:
      raw_tag: ${{ steps.version.outputs.raw_tag }}
      app_version: ${{ steps.version.outputs.app_version }}
      chart_version: ${{ steps.version.outputs.chart_version }}

    steps:
      - name: Checkout release source
        uses: actions/checkout@f548e57e544e1ff5a4c46bf1e1b8685f8e4a348a # v7
        with:
          ref: ${{ github.event.workflow_run.head_sha || (startsWith(inputs.version, 'refs/tags/') && inputs.version || format('refs/tags/{0}', inputs.version)) }}
          persist-credentials: false

      # Both inputs reach the shell through env rather than `${{ }}`
      # interpolation. A git ref name may contain `$(...)` — anything without a
      # space is a legal tag — and interpolation pastes it into the script
      # verbatim, where bash would run it. Reading "$RAW_INPUT" instead makes it
      # data.
      - name: Normalize release version
        id: version
        env:
          RAW_INPUT: ${{ github.event.inputs.version }}
          RAW_BRANCH: ${{ github.event.workflow_run.head_branch }}
        run: |
          set -eux

          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
            RAW="$RAW_INPUT"
          else
            RAW="$RAW_BRANCH"
          fi

          case "$RAW" in
            refs/tags/*)
              RAW_TAG="${RAW#refs/tags/}"
              ;;
            *)
              RAW_TAG="$RAW"
              ;;
          esac

          ./scripts/helm_chart_version.sh "$RAW_TAG"

      # Docker and Helm share the binary-build trigger. Do not publish a chart
      # until the image selected by its default appVersion is pullable.
      - name: Wait for release image
        timeout-minutes: 20
        env:
          APP_VERSION: ${{ steps.version.outputs.app_version }}
        run: |
          set -euo pipefail
          if [[ ! "$APP_VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?$ ]] ||
             [[ "$APP_VERSION" == *-preview* ]]; then
            echo "Invalid deliverable image version: $APP_VERSION" >&2
            exit 1
          fi

          for attempt in {1..60}; do
            if token=$(curl --fail --silent --show-error --connect-timeout 10 --max-time 20 \
              'https://auth.docker.io/token?service=registry.docker.io&scope=repository:rustfs/rustfs:pull' \
              | jq -er '.token // empty') &&
              curl --fail --silent --show-error --head --connect-timeout 10 --max-time 20 \
                --header "Authorization: Bearer $token" \
                --header 'Accept: application/vnd.oci.image.index.v1+json, application/vnd.docker.distribution.manifest.list.v2+json' \
                "https://registry-1.docker.io/v2/rustfs/rustfs/manifests/$APP_VERSION" > /dev/null; then
              echo "Release image is available: rustfs/rustfs:$APP_VERSION"
              exit 0
            fi
            echo "Waiting for rustfs/rustfs:$APP_VERSION ($attempt/60)"
            if (( attempt < 60 )); then
              sleep 15
            fi
          done

          echo "Release image is unavailable; refusing to publish Helm chart" >&2
          exit 1

      - name: Replace chart version and app version
        env:
          CHART_VERSION: ${{ steps.version.outputs.chart_version }}
          APP_VERSION: ${{ steps.version.outputs.app_version }}
        run: |
          set -eux
          sed -i -E "s/^version:.*/version: \"${CHART_VERSION}\"/" helm/rustfs/Chart.yaml
          sed -i -E "s/^appVersion:.*/appVersion: \"${APP_VERSION}\"/" helm/rustfs/Chart.yaml

      - name: Set up Helm
        uses: azure/setup-helm@b9e51907a09c216f16ebe8536097933489208112 # v4.3.0

      - name: Test Helm Chart Templates
        run: ./scripts/test_helm_templates.sh

      - name: Package Helm Chart
        run: |
          set -eux
          cp helm/README.md helm/rustfs/
          helm package ./helm/rustfs \
            --destination helm/rustfs/ \
            --version "${{ steps.version.outputs.chart_version }}"

      - name: Upload helm package as artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: helm-package
          path: |
            helm/rustfs/*.tgz
            helm/rustfs/README.md
          retention-days: 1

  publish-helm-package:
    runs-on: sm-standard-2
    timeout-minutes: 30
    needs: [ build-helm-package ]
    if: needs.build-helm-package.result == 'success'

    steps:
      - name: Checkout helm package repo
        uses: actions/checkout@f548e57e544e1ff5a4c46bf1e1b8685f8e4a348a # v7
        with:
          # persist-credentials-exempt: this checkout's token IS the push credential —
          # the job git-pushes to rustfs/helm below. Clearing it breaks chart publishing.
          repository: rustfs/helm
          token: ${{ secrets.RUSTFS_HELM_PACKAGE }}

      - name: Download helm package
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
        with:
          name: helm-package
          path: ./

      - name: Set up helm
        uses: azure/setup-helm@b9e51907a09c216f16ebe8536097933489208112 # v4.3.0

      - name: Generate index
        run: helm repo index . --url https://charts.rustfs.com

      # app_version is derived from the triggering tag name, and this job holds
      # the cross-repository push token with rustfs/helm already checked out —
      # the worst place in the repo to paste an attacker-influenced string into
      # a shell line. Passed through env so bash treats it as data.
      - name: Push helm package and index file
        env:
          GIT_USERNAME: ${{ secrets.USERNAME }}
          GIT_EMAIL: ${{ secrets.EMAIL_ADDRESS }}
          APP_VERSION: ${{ needs.build-helm-package.outputs.app_version }}
        run: |
          set -eux
          git config --global user.name "${GIT_USERNAME}"
          git config --global user.email "${GIT_EMAIL}"
          git add .
          git commit -m "Update rustfs helm package with ${APP_VERSION}." || echo "No changes to commit"
          git push origin main