Merge branch 'develop' into doc/terraform-iac-best-practices

zenml-io · Oct 26, 2024 · f3ac640 · f3ac640
2 parents ad7a734 + 128b32f
commit f3ac640
Show file tree

Hide file tree

Showing 52 changed files with 1,853 additions and 1,046 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -6,14 +6,14 @@ structure:
 
 redirects:
   how-to/customize-docker-builds/use-code-repositories-to-speed-up-docker-build-times: how-to/customize-docker-builds/how-to-reuse-builds.md
-  reference/migration-guide/README.md: how-to/manage-the-zenml-server/migration-guide/migration-guide.md
-  reference/migration-guide/migration-zero-twenty.md: how-to/manage-the-zenml-server/migration-guide/migration-zero-twenty.md
-  reference/migration-guide/migration-zero-thirty.md: how-to/manage-the-zenml-server/migration-guide/migration-zero-thirty.md
-  reference/migration-guide/migration-zero-forty.md: how-to/manage-the-zenml-server/migration-guide/migration-zero-forty.md
-  reference/migration-guide/migration-zero-sixty.md: how-to/manage-the-zenml-server/migration-guide/migration-zero-sixty.md
+  reference/migration-guide: how-to/manage-the-zenml-server/migration-guide/migration-guide.md
+  reference/migration-guide/migration-zero-twenty: how-to/manage-the-zenml-server/migration-guide/migration-zero-twenty.md
+  reference/migration-guide/migration-zero-thirty: how-to/manage-the-zenml-server/migration-guide/migration-zero-thirty.md
+  reference/migration-guide/migration-zero-forty: how-to/manage-the-zenml-server/migration-guide/migration-zero-forty.md
+  reference/migration-guide/migration-zero-sixty: how-to/manage-the-zenml-server/migration-guide/migration-zero-sixty.md
 
-  getting-started/deploying-zenml/manage-the-deployed-services/upgrade-the-version-of-the-zenml-server.md: how-to/manage-the-zenml-server/upgrade-zenml-server.md
-  getting-started/deploying-zenml/manage-the-deployed-services/troubleshoot-your-deployed-server.md: how-to/manage-the-zenml-server/troubleshoot-your-deployed-server.md
-  how-to/stack-deployment/implement-a-custom-integration.md: how-to/contribute-to-zenml/implement-a-custom-integration.md
-
-  getting-started/zenml-pro/system-architectures: getting-started/system-architectures.md
+  getting-started/deploying-zenml/manage-the-deployed-services/upgrade-the-version-of-the-zenml-server: how-to/manage-the-zenml-server/upgrade-zenml-server.md
+  getting-started/deploying-zenml/manage-the-deployed-services/troubleshoot-your-deployed-server: how-to/manage-the-zenml-server/troubleshoot-your-deployed-server.md
+  how-to/stack-deployment/implement-a-custom-integration: how-to/contribute-to-zenml/implement-a-custom-integration.md
+  how-to/setting-up-a-project-repository/best-practices: how-to/setting-up-a-project-repository/set-up-repository.md
+  getting-started/zenml-pro/system-architectures: getting-started/system-architectures.md
diff --git a/.github/workflows/ci-fast.yml b/.github/workflows/ci-fast.yml
@@ -86,6 +86,10 @@ jobs:
     if: github.event.pull_request.draft == false
     strategy:
       matrix:
+        # IMPORTANT: Since we are using the combination of `arc-runner-set`
+        # and `3.10` in our `ci-fast` workflow, this combination has been
+        # excluded from the `ci-slow` workflow. If you change the configuration
+        # here, please adjust the configuration of `ci-slow` accordingly.
         os: [arc-runner-set]
         python-version: ['3.10']
       fail-fast: false
@@ -98,6 +102,11 @@ jobs:
     if: github.event.pull_request.draft == false
     strategy:
       matrix:
+        # IMPORTANT: Since we are using the combinations of `arc-runner-set`
+        # `3.10` and two different test environments in our `ci-fast` workflow,
+        # these combination have been excluded from the `ci-slow` workflow.
+        # If you change the configuration here, please adjust the configuration
+        # of `ci-slow` accordingly.
         os: [arc-runner-set]
         python-version: ['3.10']
         test_environment: [default, docker-server-docker-orchestrator-mysql]

diff --git a/.github/workflows/ci-slow.yml b/.github/workflows/ci-slow.yml
@@ -39,23 +39,6 @@ jobs:
         run: |
           echo "Please add the 'run-slow-ci' label to this PR before merging."
           exit 1
-  docstring-check:
-    if: github.event.pull_request.draft == false
-    needs: run-slow-ci-label-is-set
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4.1.1
-      - name: Set up Python
-        uses: actions/setup-python@v5.0.0
-        with:
-          python-version: '3.10'
-      - name: Install current package as editable
-        run: |
-          curl -LsSf https://astral.sh/uv/install.sh | sh
-          source $HOME/.cargo/env
-          uv pip install --system darglint
-      - name: Check docstrings
-        run: bash scripts/docstring.sh
   mysql-db-migration-testing-full:
     if: github.event.pull_request.draft == false
     needs: run-slow-ci-label-is-set
@@ -195,6 +178,12 @@ jobs:
       matrix:
         os: [arc-runner-set]
         python-version: ['3.9', '3.10', '3.11', '3.12']
+        # IMPORTANT: Since we are using the following combination
+        # in our `ci-fast` workflow, this combination has been
+        # excluded from the `ci-slow` workflow.
+        exclude:
+          - os: arc-runner-set
+            python-version: '3.10'
       fail-fast: false
     uses: ./.github/workflows/unit-test.yml
     with:
@@ -294,6 +283,15 @@ jobs:
             python-version: '3.11'
           - test_environment: docker-server-docker-orchestrator-mariadb
             python-version: '3.12'
+          # IMPORTANT: Since we are using the following combinations
+          # in our `ci-fast` workflow, this combination has been
+          # excluded from the `ci-slow` workflow.
+          - os: arc-runner-set
+            test_environment: default
+            python-version: '3.10'
+          - os: arc-runner-set
+            test_environment: docker-server-docker-orchestrator-mysql
+            python-version: '3.10'
       fail-fast: false
     uses: ./.github/workflows/integration-test-slow.yml
     with:

diff --git a/.github/workflows/release_finalize.yml b/.github/workflows/release_finalize.yml
@@ -2,48 +2,20 @@
 name: release-finalize
 on:
   workflow_dispatch:
-  pull_request:
-    types: [closed]
-    branches: ["misc/prepare-release-*"]
+    inputs:
+      latest_version:
+        description: "The latest version of ZenML"
+        required: true
+        type: string
+      new_version:
+        description: "The new version of ZenML"
+        required: true
+        type: string
 env:
   ZENML_ANALYTICS_OPT_IN: false
   GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 jobs:
-  fetch-versions:
-    if: github.repository == 'zenml-io/zenml' && github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'misc/prepare-release-')
-    runs-on: ubuntu-latest
-    outputs:
-      old_version: ${{ steps.old-version.outputs.old_version }}
-      new_version: ${{ steps.new-version.outputs.new_version }}
-    steps:
-      # Extract the version
-      - name: Extract version from branch name
-        id: new-version
-        run: |
-          BRANCH_NAME=${GITHUB_REF#refs/heads/}
-          NEW_VERSION=${BRANCH_NAME#misc/prepare-release-}
-          echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
-      # Checkout main as develop is already changed
-      - name: Checkout code
-        id: checkout-code
-        uses: actions/checkout@v4.1.1
-        with:
-          ref: main
-      # Configure Git
-      - name: Configure git
-        shell: bash
-        run: |
-          git config --global user.email "info@zenml.io"
-          git config --global user.name "ZenML GmbH"
-      # Extract the old version
-      - name: Fetch the old version
-        id: old-version
-        run: |
-          LATEST_RELEASE=$(gh release view --json tagName,publishedAt -q '{tag: .tagName, date: .publishedAt}')
-          OLD_VERSION=$(echo "$LATEST_RELEASE" | jq -r .tag)
-          echo "old_version=$OLD_VERSION" >> $GITHUB_OUTPUT
   create-release-branch:
-    needs: fetch-versions
     runs-on: ubuntu-latest
     steps:
       # Configure Git
@@ -60,10 +32,10 @@ jobs:
       # Create the release branch
       - name: Release branch
         run: |
-          git checkout -b release/${{ needs.fetch-versions.outputs.new_version }}
-          git push --set-upstream origin release/${{ needs.fetch-versions.outputs.new_version }}
+          git pull
+          git checkout -b release/${{ github.event.inputs.latest_version }}
+          git push --set-upstream origin release/${{ github.event.inputs.new_version }}
   add-docs-warning-header:
-    needs: fetch-versions
     runs-on: ubuntu-latest
     steps:
       # Configure Git
@@ -76,14 +48,14 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4.1.1
         with:
-          ref: release/${{ needs.fetch-versions.outputs.old_version }}
+          ref: release/${{ github.event.inputs.latest_version }}
       # Create the docs update PR
       - name: Create docs update PR
         shell: bash
         run: |
-          bash scripts/add-docs-warning.sh ${{ needs.fetch-versions.outputs.old_version }}
+          git pull
+          bash scripts/add-docs-warning.sh ${{ github.event.inputs.latest_version }}
   add-new-version-to-migration-tests:
-    needs: fetch-versions
     runs-on: ubuntu-latest
     steps:
       # Configure Git
@@ -101,9 +73,9 @@ jobs:
       - name: Create docs update PR
         shell: bash
         run: |-
-          bash scripts/add-migration-test-version.sh ${{ needs.fetch-versions.outputs.old_version }} ${{ needs.fetch-versions.outputs.new_version }}
+          git pull
+          bash scripts/add-migration-test-version.sh ${{ github.event.inputs.latest_version }} ${{ github.event.inputs.new_version }}
   order-gitbook-release-spaces:
-    needs: fetch-versions
     runs-on: ubuntu-latest
     steps:
       # Check out develop
@@ -124,15 +96,15 @@ jobs:
       # Adjust the docs
       - name: Adjust gitbook docs
         env:
-          ZENML_NEW_VERSION: ${{ needs.fetch-versions.outputs.new_version }
-          ZENML_OLD_VERSION: ${{ needs.fetch-versions.outputs.old_version }
+          ZENML_NEW_VERSION: ${{ github.event.inputs.new_version }}
+          ZENML_OLD_VERSION: ${{ github.event.inputs.latest_version }}
           GITBOOK_API_KEY: ${{secrets.GITBOOK_API_KEY}}
           GITBOOK_ORGANIZATION: ${{secrets.GITBOOK_ORGANIZATION}}
           GITBOOK_DOCS_COLLECTION: ${{secrets.GITBOOK_DOCS_COLLECTION}}
           GITBOOK_LEGACY_COLLECTION: ${{secrets.GITBOOK_LEGACY_COLLECTION}}
         run: python scripts/sync-gitbook-release-spaces.py
   deprecate-docs-gitbook-legacy:
-    needs: [fetch-versions, order-gitbook-release-spaces]
+    needs: order-gitbook-release-spaces
     runs-on: ubuntu-latest
     steps:
       # Configure Git
@@ -150,4 +122,4 @@ jobs:
       - name: Update legacy docs file
         shell: bash
         run: |-
-          bash scripts/deprecate-previous-docs-to-legacy.sh ${{ needs.fetch-versions.outputs.old_version }}
+          bash scripts/deprecate-previous-docs-to-legacy.sh ${{ github.event.inputs.latest_version }}
diff --git a/.github/workflows/release_prepare.yml b/.github/workflows/release_prepare.yml
@@ -1,16 +1,15 @@
 ---
 name: release-prepare
 on:
-  workflow_dispatch:
-  create:
-    branches: ["misc/prepare-release-*"]
-    types: [branch]
+  push:
+    branches:
+      - "misc/prepare-release-*"
 env:
   ZENML_ANALYTICS_OPT_IN: false
   GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 jobs:
   fetch-versions:
-    if: github.repository == 'zenml-io/zenml'
+    if: github.event.created && github.repository == 'zenml-io/zenml'
     runs-on: ubuntu-latest
     outputs:
       old_version: ${{ steps.old-version.outputs.old_version }}
@@ -241,4 +240,4 @@ jobs:
           sed -i 's|zenml\[server\]==[^[:space:]]*|git+https://github.com/zenml-io/zenml.git@${{ github.ref }}#egg=zenml[server]|g' requirements_${{ matrix.cloud }}.txt
           pip install -r requirements_${{ matrix.cloud }}.txt
           zenml integration install ${{ matrix.cloud }} -y
-          python run.py --model_type=t5-small
+          python run.py --model_type=t5-small --no-cache
diff --git a/README.md b/README.md
@@ -327,7 +327,7 @@ the Apache License Version 2.0.
     <a href="https://github.com/zenml-io/zenml-projects">Projects Showcase</a>
     <br />
     <br />
-    🎉 Version 0.67.0 is out. Check out the release notes
+    🎉 Version 0.68.0 is out. Check out the release notes
     <a href="https://github.com/zenml-io/zenml/releases">here</a>.
     <br />
     🖥️ Download our VS Code Extension <a href="https://marketplace.visualstudio.com/items?itemName=ZenML.zenml-vscode">here</a>.