Merge remote-tracking branch 'origin/improvement/update-github-actions-runners' into w/129.0/improvement/update-github-actions-runners

Author: TeddyAndrieux

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/devcontainers/base:jammy
+FROM mcr.microsoft.com/devcontainers/base:noble
 
 RUN export DEBIAN_FRONTEND=noninteractive && \
     apt-get update && \
@@ -7,10 +7,12 @@ RUN export DEBIAN_FRONTEND=noninteractive && \
         bash-completion \
         build-essential \
         curl \
+        docker.io \
         enchant-2 \
         gawk \
         gcc \
         genisoimage \
+        gh \
         git \
         isomd5sum \
         libassuan-dev \
@@ -24,7 +26,6 @@ RUN export DEBIAN_FRONTEND=noninteractive && \
         npm \
         pkg-config \
         plantuml \
-        python3.10-gdbm \
         shellcheck \
         tk-dev \
         tmux \
@@ -36,20 +37,54 @@ RUN export DEBIAN_FRONTEND=noninteractive && \
 
 USER vscode
 
+ENV LANG=C.UTF-8
+ENV LC_ALL=C.UTF-8
+
+# NOTE: Due to a bug in recent babel version, it cannot work with
+# default UTC timezone
+# See: https://github.com/python-babel/babel/issues/990
+RUN sudo ln -fs /usr/share/zoneinfo/UTC /etc/localtime
+
+ENV PYENV_ROOT="/usr/local/pyenv"
+ENV PATH="$PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH"
+
+# Install pyenv
+RUN sudo git clone https://github.com/pyenv/pyenv.git $PYENV_ROOT && \
+    sudo chown $(id -u):$(id -g) -R $PYENV_ROOT && \
+    printf 'export PYENV_ROOT=%s\nexport PATH="$PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH"\nif command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi\n' $PYENV_ROOT | sudo tee -a /etc/bash.bashrc -a /etc/zsh/zshrc
+
+# Install pythons
+RUN pyenv install 3.10.12 3.6.15 2.7 && \
+    pyenv global 3.10.12 3.6.15 2.7
+
+# Install python libs
+RUN pip3 install --no-cache-dir --upgrade pip && \
+    pip3.6 install --no-cache-dir --upgrade pip && \
+    pip3 install --no-cache-dir "tox~=4.4.12" "pre-commit~=3.3.3" "virtualenv<20.22.0" "esbonio>=0.12.0" && \
+    pip3.6 install --no-cache-dir "poetry~=1.1.15" && \
+    pyenv rehash
+
 # Install helm
-ARG HELM_VERSION=3.16.2
+ARG HELM_VERSION=3.17.2
 
 RUN curl --fail -L -o /tmp/helm.tar.gz https://get.helm.sh/helm-v${HELM_VERSION}-linux-amd64.tar.gz && \
     sudo tar -zxvf /tmp/helm.tar.gz -C /usr/local/bin/ linux-amd64/helm --strip-components 1 && \
     rm -rf /tmp/helm.tar.gz
 
 # Install go
 ARG GO_VERSION=1.21.13
+ENV GOROOT="/usr/local/go"
+# NOTE: We use a custom GOPATH so that we can use it both for vscode and root users
+ENV GOPATH="/usr/lib/go"
+ENV GOBIN="$GOPATH/bin"
+ENV PATH="$GOBIN:$GOROOT/bin:$PATH"
 
 RUN curl --fail -L -o /tmp/go.tar.gz https://go.dev/dl/go${GO_VERSION}.linux-amd64.tar.gz && \
-    sudo tar -C /usr/local -xzf /tmp/go.tar.gz && \
-    sudo ln -s /usr/local/go/bin/go /usr/local/bin/go && \
-    sudo ln -s /usr/local/go/bin/gofmt /usr/local/bin/gofmt && \
+    sudo tar -C /usr/local/ -xzf /tmp/go.tar.gz && \
+    sudo mkdir -p $GOPATH && \
+    sudo chown $(id -u):$(id -g) -R $GOROOT $GOPATH && \
+    cd $GOROOT/bin && mv go go${GO_VERSION} && ln -s go${GO_VERSION} go && \
+    printf 'export PATH="%s:%s/bin:$PATH"\n' $GOBIN $GOROOT | sudo tee -a /etc/bash.bashrc -a /etc/zsh/zshrc && \
     rm -rf /tmp/go.tar.gz
 
 # Install golangci-lint
@@ -59,20 +94,8 @@ RUN curl --fail -L -o /tmp/install.sh https://raw.githubusercontent.com/golangci
     sudo bash /tmp/install.sh v${GOLANGCI_VERSION} && \
     rm -f /tmp/install.sh
 
-# Install pyenv
-RUN git clone https://github.com/pyenv/pyenv.git ~/.pyenv && \
-    echo 'export PATH="$HOME/.pyenv/bin:$PATH"\nif command -v pyenv 1>/dev/null 2>&1; then\n eval "$(pyenv init -)"\nfi' | tee -a ~/.bashrc -a ~/.zshrc && \
-    export PATH="$HOME/.pyenv/bin:$PATH" && eval "$(pyenv init -)"
-
-# Install pythons
-RUN ~/.pyenv/bin/pyenv install 3.10.12 3.6.15 && \
-    ~/.pyenv/bin/pyenv global 3.10.12 3.6.15
-
-# Install python libs
-RUN ~/.pyenv/bin/pyenv exec pip install "tox~=4.4.12" "pre-commit~=3.3.3" "virtualenv<20.22.0" "esbonio>=0.12.0"
-
-# Install crane and gcrane
-ARG CRANE_VERSION=0.20.2
+# Install crane
+ARG CRANE_VERSION=0.20.3
 
 RUN curl --fail -L -o /tmp/crane.tar.gz https://github.com/google/go-containerregistry/releases/download/v${CRANE_VERSION}/go-containerregistry_Linux_x86_64.tar.gz && \
     sudo tar -xzf /tmp/crane.tar.gz -C /usr/local/bin/ crane gcrane && \
@@ -84,7 +107,7 @@ ARG SKOPEO_VERSION=1.15.1
 RUN curl --fail -L -o /tmp/skopeo.tar.gz https://github.com/containers/skopeo/archive/refs/tags/v${SKOPEO_VERSION}.tar.gz && \
     tar -zxvf /tmp/skopeo.tar.gz -C /tmp && \
     cd /tmp/skopeo-${SKOPEO_VERSION} && \
-    sudo make bin/skopeo && \
+    sudo "PATH=$PATH" make bin/skopeo && \
     sudo mv bin/skopeo /usr/local/bin/ && \
     cd && \
     rm -rf /tmp/skopeo.tar.gz /tmp/skopeo-${SKOPEO_VERSION}

.devcontainer/devcontainer.json

@@ -1,7 +1,13 @@
 {
   "name": "metalk8s",
   "build": {
-    "dockerfile": "Dockerfile"
+    "dockerfile": "Dockerfile",
+    "options": [
+      "--platform=linux/amd64"
+    ],
+    "cacheFrom": [
+      "type=gha,scope=devcontainer"
+    ]
   },
   "features": {
     "ghcr.io/devcontainers/features/sshd:1": {},

.devcontainer/setup.sh

@@ -13,13 +13,7 @@ if [ "$CODESPACES" = "true" ]; then
   git reset --hard HEAD
 fi
 
-# NOTE: Due to a bug in recent babel version, it cannot work with
-# default UTC timezone
-# See: https://github.com/python-babel/babel/issues/990
-echo "Updating localtime"
-sudo ln -fs /usr/share/zoneinfo/UTC /etc/localtime
-
 echo "Install pre-commit hooks"
-pre-commit install
+pre-commit install --install-hooks
 
 echo "End of setup"

.github/changed-files.yaml

@@ -9,6 +9,7 @@ docs:
   - tools/lib-alert-tree/**
   - tools/rule_extractor/alerting_rules.json
   - tox.ini
+  - .devcontainer/**
 
 shell-ui:
   - shell-ui/**
@@ -26,16 +27,20 @@ unit-tests-crd-client-generator:
 
 unit-tests-metalk8s-operator:
   - operator/**
+  - .devcontainer/**
 
 unit-tests-storage-operator:
   - storage-operator/**
+  - .devcontainer/**
 
 unit-tests-salt:
   - salt/**
   - tox.ini
+  - .devcontainer/**
 
 unit-tests-lib-alert-tree:
   - tools/lib-alert-tree/**
+  - .devcontainer/**
 
 integration-tests-ui:
   - *ui
@@ -74,7 +79,6 @@ build:
   - "!solution-operator-lib/**"
   # Filter out devX and tools
   - "!.pre-commit-config.yaml"
-  - "!.devcontainer/**"
   - "!.gitignore"
   - "!LICENSE"
   - "!README.md"

.github/workflows/build-devcontainer.yaml

@@ -0,0 +1,39 @@
+name: build devcontainer
+
+on:
+  workflow_call:
+    inputs:
+      skip:
+        type: boolean
+        required: false
+        default: false
+        description: 'Skip the build and publish'
+
+jobs:
+  build-and-publish-devcontainer:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to the registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build dev container
+        # NOTE: We only skip this and not the full Job
+        # otherwise step that "need" it will not be started
+        if: ${{ ! inputs.skip }}
+        uses: docker/build-push-action@v6
+        with:
+          context: .devcontainer/
+          push: true
+          tags: ghcr.io/${{ github.repository }}/devcontainer:${{ github.sha }}
+          cache-from: type=gha,scope=devcontainer
+          cache-to: type=gha,mode=max,scope=devcontainer

.github/workflows/build-docs.yaml

@@ -8,30 +8,50 @@ on:
         default: ${{ github.ref }}
         required: false
         type: string
+      build-devcontainer:
+        description: "True will build the devcontainer"
+        default: true
+        required: false
+        type: boolean
     secrets:
       ARTIFACTS_USER:
         required: true
       ARTIFACTS_PASSWORD:
         required: true
 
 jobs:
+  build-devcontainer:
+    uses: ./.github/workflows/build-devcontainer.yaml
+    secrets: inherit
+    with:
+      # NOTE: We check "!= true" instead of just checking the value
+      # since by default when the workflow is call with "workflow dispatch"
+      # the input will (sadly) be "" and not use the default value
+      skip: ${{ inputs.build-devcontainer != true }}
+
   docs:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
+    needs:
+      - build-devcontainer
+    container:
+      image: ghcr.io/${{ github.repository }}/devcontainer:${{ github.sha }}
+      # We have to use `root` for the moment
+      # Sees: https://github.com/actions/checkout/issues/1575
+      # Could work with a user with 1001 id but not for docker
+      options: --user root
+      credentials:
+        username: ${{ github.repository_owner }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+    defaults:
+      run:
+        shell: bash
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           ref: ${{ inputs.ref }}
-      - name: Install Python 3
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.10"
-      - name: Install deps
-        run: |
-          export DEBIAN_FRONTEND=noninteractive
-          sudo apt-get update
-          sudo apt-get install --no-install-recommends -y plantuml
-          python3.10 -m pip install tox~=4.0.19
+      - name: Set safe directory (since container is root and not user 1001)
+        run: git config --global --add safe.directory $GITHUB_WORKSPACE
       - name: Build documentation for ReadTheDocs
         env:
           # Fake that we are building in a ReadTheDocs environment

.github/workflows/build-shell-ui.yaml

@@ -16,7 +16,7 @@ on:
 
 jobs:
   shell-ui:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4