Merge pull request #247 from circleci/fix-bucket

fix: update S3 bucket paths for docs preview deployment

Author: rosieyohannan

.circleci/config.yml

@@ -15,6 +15,11 @@ executors:
       - image: cimg/node:22.15.1
     working_directory: ~/project
 
+  python_executor:
+    docker:
+      - image: cimg/python:3.12.11
+    working_directory: ~/project
+
   ruby_executor:
     docker:
       - image: cimg/ruby:3.4
@@ -185,7 +190,7 @@ jobs:
           message: "Deploy preview job failed for branch ${CIRCLE_BRANCH}"
 
   deploy-production:
-    executor: node_executor
+    executor: python_executor
     parameters:
       bucket_name:
         description: The name of the s3 bucket where static assets are stored.
@@ -208,13 +213,26 @@ jobs:
             echo "[INFO] Deploying production site..."
             aws s3 sync "$BUILD_DIRECTORY" "s3://$AWS_S3_BUCKET/"
       - run:
-          name: Deploy Single Test Redirect to S3
+          name: install pyyaml requests
+          command: |
+            set -e
+            echo "[INFO] Installing pyyaml requests..."
+            pip install pyyaml requests
+      - run:
+          name: Deploy Redirects to S3
           command: |
             AWS_S3_BUCKET=<< parameters.bucket_name >>
 
             set -e
-            echo "[INFO] Deploying single test redirect..."
-            bash scripts/test-single-redirect.sh "$AWS_S3_BUCKET"
+            echo "[INFO] Deploying redirects..."
+            #REMEMBER TO UPDATE THE START/END PARAMETER IN THE VALIDATE JOB TO MATCH
+            python scripts/create-redirects.py $AWS_S3_BUCKET --start 0 --end 10
+      - run:
+          name: Validate Redirects
+          command: |
+            set -e
+            echo "[INFO] Validating redirects..."
+            python scripts/validate-redirects.py https://circleci.com/docs-preview --start 0 --end 10
       - notify_error:
           message: "Production deployment job failed for branch ${CIRCLE_BRANCH}"
 
@@ -299,7 +317,7 @@ workflows:
               web-ui-npm,
               web-ui-datadog,
             ]
-          bucket_name: "circleci-docs-platform-assets/docs-preview"
+          bucket_name: "circleci-docs-platform-assets"
           build_dir: "build"
   cleanup_preview:
     when: pipeline.parameters.cleanup_preview_branch != ""

scripts/create-redirect.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+set -e
+
+# Validate parameters
+if [ "$#" -ne 3 ]; then
+  echo "Usage: $0 <bucket_name> <old_path> <new_path>"
+  echo "Example: $0 circleci-docs-platform-assets /about-circleci/ /docs-preview/guides/about-circleci/index.html"
+  exit 1
+fi
+
+DESTINATION_FOLDER="docs-preview"
+
+BUCKET_NAME="$1"
+OLD_PATH="$2"   # must include leading and trailing slash e.g. /about-circleci/
+NEW_PATH="/${DESTINATION_FOLDER}$3"   # full target path e.g. /docs-preview/guide/about-circleci/index.html
+
+echo "[INFO] Deploying redirect to bucket: s3://$BUCKET_NAME"
+echo "[INFO] Redirect: $OLD_PATH -> $NEW_PATH"
+
+# Convert old path to S3 key (no leading slash before key!)
+S3_KEY="${DESTINATION_FOLDER}${OLD_PATH}index.html"
+
+echo "[INFO] Creating S3 object: $S3_KEY"
+
+# Create the redirect object in S3
+aws s3api put-object \
+  --bucket "$BUCKET_NAME" \
+  --key "$S3_KEY" \
+  --website-redirect-location "$NEW_PATH" \
+  --content-type "text/html" \
+  --content-length "0"
+
+echo "[INFO] ✅ Redirect created successfully!"

scripts/create-redirects.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+"""Bulk S3 redirect creator.
+
+Reads redirects from scripts/redirects_v2.yml (expects list of mapping with
+`old` and `new` keys) and calls `scripts/create-redirect.sh` for each redirect.
+
+Usage:
+    python scripts/create-redirect.py <bucket_name> [--start N] [--end M]
+
+Options:
+    --start N   Start index (inclusive) in redirects list to process. Default 0.
+    --end M     End index (exclusive). Default len(list).
+
+The slice options are useful for testing a subset.
+"""
+from __future__ import annotations
+
+import argparse
+import subprocess
+import sys
+from pathlib import Path
+
+try:
+    import yaml  # type: ignore
+except ImportError:  # pragma: no cover
+    sys.stderr.write("[ERROR] PyYAML is required. Install with: pip install pyyaml\n")
+    sys.exit(1)
+
+ROOT_DIR = Path(__file__).resolve().parent.parent  # repo root (circleci-docs-static)
+REDIRECTS_FILE = ROOT_DIR / "scripts" / "redirects_v2.yml"
+SH_SCRIPT = ROOT_DIR / "scripts" / "create-redirect.sh"
+
+
+def load_redirects(path: Path) -> list[dict[str, str]]:
+    """Load redirects YAML file into list of dicts with 'old' and 'new'."""
+    if not path.exists():
+        raise FileNotFoundError(f"Redirects YAML not found: {path}")
+
+    with path.open("r", encoding="utf-8") as fh:
+        data = yaml.safe_load(fh)
+
+    if not isinstance(data, list):
+        raise ValueError("Redirects YAML should be a list of mappings.")
+
+    redirects: list[dict[str, str]] = []
+    for item in data:
+        if not isinstance(item, dict):
+            continue
+        old = item.get("old")
+        new = item.get("new")
+        if old and new:
+            redirects.append({"old": str(old), "new": str(new)})
+    return redirects
+
+
+def create_redirect(bucket: str, old_path: str, new_path: str) -> None:
+    """Call the shell script to create a single redirect."""
+    cmd = [
+        "bash",
+        str(SH_SCRIPT),
+        bucket,
+        old_path,
+        new_path,
+    ]
+    subprocess.run(cmd, check=True)
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Bulk S3 redirect creator")
+    parser.add_argument("bucket", help="Target S3 bucket name")
+    parser.add_argument("--start", type=int, default=0, help="Start index (inclusive)")
+    parser.add_argument("--end", type=int, default=None, help="End index (exclusive)")
+    args = parser.parse_args()
+
+    redirects = load_redirects(REDIRECTS_FILE)
+    end = args.end if args.end is not None else len(redirects)
+
+    slice_redirects = redirects[args.start : end]
+    total = len(slice_redirects)
+    print(f"[INFO] Processing {total} redirects (indexes {args.start}-{end-1})...")
+
+    for idx, entry in enumerate(slice_redirects, start=args.start):
+        old = entry["old"]
+        new = entry["new"]
+        try:
+            print(f"[INFO] ({idx}) Creating redirect {old} -> {new}")
+            create_redirect(args.bucket, old, new)
+        except subprocess.CalledProcessError as exc:
+            print(f"[ERROR] Failed to create redirect for {old}: {exc}", file=sys.stderr)
+
+
+if __name__ == "__main__":
+    main()

scripts/redirects_v2.yml

@@ -3,10 +3,10 @@
 # Total redirects: 502
 
 - old: /about-circleci/
-  new: /guides/about-circleci/about-circleci/index.html
+  new: /guides/about-circleci/index.html
 
 - old: /add-ssh-key/
-  new: /guides/integration/add-ssh-key/index.html
+  new: /guides/integration/add-ssh-key.html
 
 - old: /android-images-support-policy/
   new: /guides/execution-managed/android-images-support-policy/index.html