Staged docs releases (#50136)

Closes #ISSUE Before you mark this PR as ready for review, make sure that you have: - [x] Added a solid test coverage and/or screenshots from doing manual testing - [x] Done a self-review taking into account security and performance aspects - [x] Aligned any UI changes with the [UI checklist](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md#uiux-checklist) Release Notes: - N/A *or* Added/Fixed/Improved ...
2026-04-30 11:10:14 +00:00
1 parent c499a95218
commit 62f7eaba0e
@@ -1,6 +1,9 @@
 # Generated from xtask::workflows::after_release
 # Rebuild with `cargo xtask workflows`.
 name: after_release
+env:
+  TAG_NAME: ${{ github.event.release.tag_name || inputs.tag_name }}
+  IS_PRERELEASE: ${{ github.event.release.prerelease || inputs.prerelease }}
 on:
  release:
    types:
@@ -25,7 +28,7 @@ jobs:
    runs-on: namespace-profile-2x4-ubuntu-2404
    steps:
    - name: after_release::rebuild_releases_page::refresh_cloud_releases
-      run: curl -fX POST https://cloud.zed.dev/releases/refresh?expect_tag=${{ github.event.release.tag_name || inputs.tag_name }}
+      run: curl -fX POST "https://cloud.zed.dev/releases/refresh?expect_tag=$TAG_NAME"
    - name: steps::checkout_repo
      uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd
      with:
@@ -34,6 +37,18 @@ jobs:
      run: ./script/redeploy-vercel
      env:
        VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+  deploy_docs:
+    if: (github.repository_owner == 'zed-industries' || github.repository_owner == 'zed-extensions')
+    permissions:
+      contents: read
+    uses: zed-industries/zed/.github/workflows/deploy_docs.yml@main
+    secrets:
+      DOCS_AMPLITUDE_API_KEY: ${{ secrets.DOCS_AMPLITUDE_API_KEY }}
+      CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+      CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+    with:
+      channel: ${{ (github.event.release.prerelease || inputs.prerelease) && 'preview' || 'stable' }}
+      checkout_ref: ${{ github.event.release.tag_name || inputs.tag_name }}
  post_to_discord:
    needs:
    - rebuild_releases_page
@@ -43,7 +58,7 @@ jobs:
    - id: get-release-url
      name: after_release::post_to_discord::get_release_url
      run: |
-        if [ "${{ github.event.release.prerelease || inputs.prerelease }}" == "true" ]; then
+        if [ "$IS_PRERELEASE" == "true" ]; then
            URL="https://zed.dev/releases/preview"
        else
            URL="https://zed.dev/releases/stable"
@@ -55,7 +70,7 @@ jobs:
      uses: 2428392/gh-truncate-string-action@b3ff790d21cf42af3ca7579146eedb93c8fb0757
      with:
        stringToTruncate: |
-          📣 Zed [${{ github.event.release.tag_name || inputs.tag_name }}](<${{ steps.get-release-url.outputs.URL }}>)  was just released!
+          📣 Zed [${{ env.TAG_NAME }}](<${{ steps.get-release-url.outputs.URL }}>)  was just released!

          ${{ github.event.release.body || inputs.body }}
        maxLength: 2000
@@ -90,7 +105,7 @@ jobs:
    - id: set-package-name
      name: after_release::publish_winget::set_package_name
      run: |
-        if ("${{ github.event.release.prerelease || inputs.prerelease }}" -eq "true") {
+        if ($env:IS_PRERELEASE -eq "true") {
            $PACKAGE_NAME = "ZedIndustries.Zed.Preview"
        } else {
            $PACKAGE_NAME = "ZedIndustries.Zed"
@@ -102,7 +117,7 @@ jobs:
      uses: vedantmgoyal9/winget-releaser@19e706d4c9121098010096f9c495a70a7518b30f
      with:
        identifier: ${{ steps.set-package-name.outputs.PACKAGE_NAME }}
-        release-tag: ${{ github.event.release.tag_name || inputs.tag_name }}
+        release-tag: ${{ env.TAG_NAME }}
        max-versions-to-keep: 5
        token: ${{ secrets.WINGET_TOKEN }}
  create_sentry_release:
@@ -127,6 +142,7 @@ jobs:
    - post_to_discord
    - publish_winget
    - create_sentry_release
+    - deploy_docs
    if: failure()
    runs-on: namespace-profile-2x4-ubuntu-2404
    steps:
@@ -1,64 +0,0 @@
-name: Deploy Docs
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  deploy-docs:
-    name: Deploy Docs
-    if: github.repository_owner == 'zed-industries'
-    runs-on: namespace-profile-16x32-ubuntu-2204
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
-        with:
-          clean: false
-
-      - name: Set up default .cargo/config.toml
-        run: cp ./.cargo/collab-config.toml ./.cargo/config.toml
-
-      - name: Build docs
-        uses: ./.github/actions/build_docs
-        env:
-          CC: clang
-          CXX: clang++
-          DOCS_AMPLITUDE_API_KEY: ${{ secrets.DOCS_AMPLITUDE_API_KEY }}
-          DOCS_CONSENT_IO_INSTANCE: ${{ secrets.DOCS_CONSENT_IO_INSTANCE }}
-
-      - name: Deploy Docs
-        uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65 # v3
-        with:
-          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          command: pages deploy target/deploy --project-name=docs
-
-      - name: Deploy Install
-        uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65 # v3
-        with:
-          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          command: r2 object put -f script/install.sh zed-open-source-website-assets/install.sh
-
-      - name: Deploy Docs Workers
-        uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65 # v3
-        with:
-          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          command: deploy .cloudflare/docs-proxy/src/worker.js
-
-      - name: Deploy Install Workers
-        uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65 # v3
-        with:
-          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
-          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
-          command: deploy .cloudflare/docs-proxy/src/worker.js
-
-      - name: Preserve Wrangler logs
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
-        if: always()
-        with:
-          name: wrangler_logs
-          path: /home/runner/.config/.wrangler/logs/
@@ -0,0 +1,153 @@
+# Generated from xtask::workflows::deploy_docs
+# Rebuild with `cargo xtask workflows`.
+name: deploy_docs
+on:
+  workflow_call:
+    inputs:
+      channel:
+        description: channel
+        type: string
+        default: ''
+      checkout_ref:
+        description: checkout_ref
+        type: string
+        default: ''
+    secrets:
+      DOCS_AMPLITUDE_API_KEY:
+        description: DOCS_AMPLITUDE_API_KEY
+        required: true
+      CLOUDFLARE_API_TOKEN:
+        description: CLOUDFLARE_API_TOKEN
+        required: true
+      CLOUDFLARE_ACCOUNT_ID:
+        description: CLOUDFLARE_ACCOUNT_ID
+        required: true
+  workflow_dispatch:
+    inputs:
+      channel:
+        description: 'Docs channel to deploy: nightly, preview, or stable'
+        type: string
+        default: ''
+      checkout_ref:
+        description: Git ref to checkout and deploy. Defaults to event SHA when omitted.
+        type: string
+        default: ''
+jobs:
+  deploy_docs:
+    if: github.repository_owner == 'zed-industries'
+    name: Build and Deploy Docs
+    runs-on: namespace-profile-16x32-ubuntu-2204
+    env:
+      DOCS_AMPLITUDE_API_KEY: ${{ secrets.DOCS_AMPLITUDE_API_KEY }}
+      CC: clang
+      CXX: clang++
+    steps:
+    - id: resolve-channel
+      name: deploy_docs::resolve_channel_step
+      run: |
+        if [ -z "$CHANNEL" ]; then
+            if [ "$GITHUB_REF" = "refs/heads/main" ]; then
+                CHANNEL="nightly"
+            else
+                echo "::error::channel input is required when ref is not main."
+                exit 1
+            fi
+        fi
+
+        case "$CHANNEL" in
+            "nightly")
+                SITE_URL="/docs/nightly/"
+                PROJECT_NAME="docs-nightly"
+                ;;
+            "preview")
+                SITE_URL="/docs/preview/"
+                PROJECT_NAME="docs-preview"
+                ;;
+            "stable")
+                SITE_URL="/docs/"
+                PROJECT_NAME="docs"
+                ;;
+            *)
+                echo "::error::Invalid docs channel '$CHANNEL'. Expected one of: nightly, preview, stable."
+                exit 1
+                ;;
+        esac
+
+        {
+            echo "channel=$CHANNEL"
+            echo "site_url=$SITE_URL"
+            echo "project_name=$PROJECT_NAME"
+        } >> "$GITHUB_OUTPUT"
+      env:
+        CHANNEL: ${{ inputs.channel }}
+    - name: steps::checkout_repo
+      uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd
+      with:
+        clean: false
+        ref: ${{ inputs.checkout_ref != '' && inputs.checkout_ref || github.sha }}
+    - name: steps::setup_cargo_config
+      run: |
+        mkdir -p ./../.cargo
+        cp ./.cargo/ci-config.toml ./../.cargo/config.toml
+    - name: steps::cache_rust_dependencies_namespace
+      uses: namespacelabs/nscloud-cache-action@a90bb5d4b27522ce881c6e98eebd7d7e6d1653f9
+      with:
+        cache: rust
+        path: ~/.rustup
+    - name: steps::setup_linux
+      run: ./script/linux
+    - name: steps::download_wasi_sdk
+      run: ./script/download-wasi-sdk
+    - name: ./script/generate-action-metadata
+      run: ./script/generate-action-metadata
+    - name: deploy_docs::lychee_link_check
+      uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332
+      with:
+        args: --no-progress --exclude '^http' './docs/src/**/*'
+        fail: true
+        jobSummary: false
+    - name: deploy_docs::install_mdbook
+      uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08
+      with:
+        mdbook-version: 0.4.37
+    - name: deploy_docs::build_docs_book
+      run: |
+        mkdir -p target/deploy
+        mdbook build ./docs --dest-dir=../target/deploy/docs/
+      env:
+        DOCS_CHANNEL: ${{ steps.resolve-channel.outputs.channel }}
+        MDBOOK_BOOK__SITE_URL: ${{ steps.resolve-channel.outputs.site_url }}
+    - name: deploy_docs::lychee_link_check
+      uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332
+      with:
+        args: --no-progress --exclude '^http' 'target/deploy/docs'
+        fail: true
+        jobSummary: false
+    - name: deploy_docs::docs_deploy_steps::deploy_to_cf_pages
+      uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65
+      with:
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+        command: pages deploy target/deploy --project-name=${{ steps.resolve-channel.outputs.project_name }} --branch main
+    - name: deploy_docs::docs_deploy_steps::upload_install_script
+      uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65
+      with:
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+        command: r2 object put -f script/install.sh zed-open-source-website-assets/install.sh
+    - name: deploy_docs::docs_deploy_steps::deploy_docs_worker
+      uses: cloudflare/wrangler-action@da0e0dfe58b7a431659754fdf3f186c529afbe65
+      with:
+        apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+        accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+        command: deploy .cloudflare/docs-proxy/src/worker.js
+    - name: deploy_docs::docs_deploy_steps::upload_wrangler_logs
+      if: always()
+      uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
+      with:
+        name: wrangler_logs
+        path: /home/runner/.config/.wrangler/logs/
+    timeout-minutes: 60
+defaults:
+  run:
+    shell: bash -euxo pipefail {0}
@@ -0,0 +1,23 @@
+# Generated from xtask::workflows::deploy_nightly_docs
+# Rebuild with `cargo xtask workflows`.
+name: deploy_nightly_docs
+on:
+  push:
+    branches:
+    - main
+jobs:
+  deploy_docs:
+    if: (github.repository_owner == 'zed-industries' || github.repository_owner == 'zed-extensions')
+    permissions:
+      contents: read
+    uses: zed-industries/zed/.github/workflows/deploy_docs.yml@main
+    secrets:
+      DOCS_AMPLITUDE_API_KEY: ${{ secrets.DOCS_AMPLITUDE_API_KEY }}
+      CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+      CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+    with:
+      channel: nightly
+      checkout_ref: ${{ github.sha }}
+defaults:
+  run:
+    shell: bash -euxo pipefail {0}
@@ -637,8 +637,9 @@ jobs:
    needs:
    - orchestrate
    if: needs.orchestrate.outputs.run_docs == 'true' && github.event_name != 'merge_group'
-    runs-on: namespace-profile-8x16-ubuntu-2204
+    runs-on: namespace-profile-16x32-ubuntu-2204
    env:
+      DOCS_AMPLITUDE_API_KEY: ${{ secrets.DOCS_AMPLITUDE_API_KEY }}
      CC: clang
      CXX: clang++
    steps:
@@ -655,27 +656,30 @@ jobs:
      with:
        cache: rust
        path: ~/.rustup
-    - name: run_tests::check_docs::lychee_link_check
-      uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332
-      with:
-        args: --no-progress --exclude '^http' './docs/src/**/*'
-        fail: true
-        jobSummary: false
    - name: steps::setup_linux
      run: ./script/linux
    - name: steps::download_wasi_sdk
      run: ./script/download-wasi-sdk
    - name: ./script/generate-action-metadata
      run: ./script/generate-action-metadata
-    - name: run_tests::check_docs::install_mdbook
+    - name: deploy_docs::lychee_link_check
+      uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332
+      with:
+        args: --no-progress --exclude '^http' './docs/src/**/*'
+        fail: true
+        jobSummary: false
+    - name: deploy_docs::install_mdbook
      uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08
      with:
        mdbook-version: 0.4.37
-    - name: run_tests::check_docs::build_docs
+    - name: deploy_docs::build_docs_book
      run: |
        mkdir -p target/deploy
        mdbook build ./docs --dest-dir=../target/deploy/docs/
-    - name: run_tests::check_docs::lychee_link_check
+      env:
+        DOCS_CHANNEL: stable
+        MDBOOK_BOOK__SITE_URL: /docs/
+    - name: deploy_docs::lychee_link_check
      uses: lycheeverse/lychee-action@82202e5e9c2f4ef1a55a3d02563e1cb6041e5332
      with:
        args: --no-progress --exclude '^http' 'target/deploy/docs'