Merge pull request #2076 from gregolsky/new-docs

New deployment scripts adjustments

Author: ppekrol

.github/workflows/build-on-pr.yml

@@ -0,0 +1,35 @@
+name: Build Docusaurus on PR
+
+on:
+  pull_request:
+    branches: [new-docs]
+    types: [opened, synchronize, reopened]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      NODE_OPTIONS: '--max-old-space-size=8192'
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+          
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build Docusaurus
+        run: npm run build
+        
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: docusaurus-build
+          path: build/
+          retention-days: 7

.github/workflows/dryrun-deploy-after-merge.yml

@@ -0,0 +1,37 @@
+name: Deploy to S3 after merge to new-docs
+
+on:
+  push:
+    branches: [new-docs]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+          
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+          
+      - name: Install dependencies
+        run: npm ci --no-audit --fund false
+        
+      - name: Run deployment script
+        shell: pwsh
+        env:
+          WHATS_NEW_URL: ${{ secrets.WHATS_NEW_URL }}
+          AWS_ACCESS_KEY_ID: FAKEKEYID
+          AWS_SECRET_ACCESS_KEY: FAKEACCESSKEY
+          AWS_DEFAULT_REGION: us-east-1
+        run: |
+          scripts/deploy.ps1 -DryRun -Versions "6.2,7.1" -CloudFrontDistributionId "FAKEDISTID" -S3BucketName "FAKEBUCKET"

docs/whats-new.mdx

@@ -6,7 +6,7 @@ pagination_prev: null
 hide_table_of_contents: true
 ---
 
-## 7.1.1 (71007) - 2025/07/22 {#71007}
+## 7.1.1 (71007) - 2025/07/22
 
 ### Server
 
@@ -57,9 +57,7 @@ hide_table_of_contents: true
 * `[Documents]` Added a confirmation checkbox to the "Delete All Documents" operation to prevent accidental data loss
 * `[Edit Document]` The "Copy document ID" button in the document editor is now always visible
 * `[Embeddings Generation]` Added info about Quantization + other tooltips
-* `[Indexes]` Improved pause/resume indexing in databases view
-
-## 7.1.0 (71005) - 2025/07/01 {#71005}
+* `[Indexes]` Improved pause/resume indexing in databases view## 7.1.0 (71005) - 2025/07/01
 
 ### Features
 

package-lock.json

@@ -51,10 +51,10 @@
 # Configuration & paths
 # ============================================================================
 
-API_BASE_URL: str | None = os.environ.get("API_WEB_RAVENDB_NET_HOST") + "/api/v1/documentation/whats-new"
+API_BASE_URL: str | None = os.environ.get("WHATS_NEW_URL")
 
 if not API_BASE_URL:
-    raise EnvironmentError("Environment variable 'API_WEB_RAVENDB_NET_HOST' is not set.")
+    raise EnvironmentError("Environment variable 'WHATS_NEW_URL' is not set.")
 
 SCRIPT_DIR = Path(__file__).resolve().parent
 PROJECT_ROOT = SCRIPT_DIR.parent  # «../» relative to /scripts
@@ -70,9 +70,6 @@
     "---\n\n"
 )
 
-# Regex that replaces markdownify's three‑dash <hr> (---) with MDX‑safe <hr/>
-HR_MARKDOWN = re.compile(r"^-{3,}$", re.MULTILINE)
-
 # Date format used by the API – helper for ``datetime.strptime``
 API_DATE_FMT = "%m/%d/%Y"
 

scripts/build_whats_new.py

@@ -12,20 +12,20 @@ Prerequisites
 * **Python ≥ 3** (`python` in PATH) – runs the changelog generator
 * **AWS CLI v2** – credentials via `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`,
   `AWS_DEFAULT_REGION` (and optional `AWS_SESSION_TOKEN`)
-* Environment variable **`API_WEB_RAVENDB_NET_HOST`** set (only required when regenerating
+* Environment variable **`WHATS_NEW_URL`** set (only required when regenerating
   *What's New* for specific versions)
 * Project `package.json` includes `@docusaurus/core` and `@docusaurus/cli`
 
 Example
 -------
 ```powershell
-# API_WEB_RAVENDB_NET_HOST must be set if you request specific versions
-$env:API_WEB_RAVENDB_NET_HOST = 'YOUR-API-KEY'
+# WHATS_NEW_URL must be set if you request specific versions
+$env:WHATS_NEW_URL = 'https://whats.new.api/v1/docs'
 
 pwsh deploy.ps1 \
      -S3BucketName my-docs-bucket \
      -CloudFrontDistributionId ABCD1234 \
-     -Versions 6.0 6.2 7.0 7.1 8.0
+     -Versions "6.0,6.2,7.0,7.1,8.0"
 ```
 ------------------------------------------------------------------------------!#>
 
@@ -37,17 +37,14 @@ param(
     [Parameter(HelpMessage = 'CloudFront distribution ID to invalidate (optional)')]
     [string]$CloudFrontDistributionId,
 
-    [Parameter(ValueFromRemainingArguments = $false, HelpMessage = "Versions to regenerate Whats New for e.g. 6.0 7.0 8.0")]
-    [string[]]$Versions = @(),
+    [Parameter(HelpMessage = "Comma-separated versions to regenerate Whats New for e.g. '6.0,6.2,7.0'")]
+    [string]$Versions = "",
 
     [Parameter(HelpMessage = 'Dry run mode. If enabled, no sync to S3 or CloudFront invalidation will occur.')]
     [switch]$DryRun
 )
 
-# ---------------------------------------------------------------------------
-# Constants & helpers
-# ---------------------------------------------------------------------------
-$PythonWhatsNewPath = Join-Path $PSScriptRoot 'build_whats_new.py'  # script lives alongside this file
+$PythonWhatsNewPath = Join-Path $PSScriptRoot 'build_whats_new.py' 
 
 function ThrowIfEmpty {
     param (
@@ -58,7 +55,7 @@ function ThrowIfEmpty {
 }
 
 function Ensure-Dependencies {
-    Write-Host 'Verifying runtime dependencies…' -ForegroundColor Cyan
+    Write-Host 'Verifying runtime dependencies...' -ForegroundColor Cyan
 
     foreach ($cmd in 'node','npm','python','aws') {
         if (-not (Get-Command $cmd -ErrorAction SilentlyContinue)) {
@@ -76,59 +73,44 @@ function Ensure-Dependencies {
 
 function Process-Changelogs {
     param (
-        [string[]]$VersionsToBuild
+        [string[]]$WhatsNewVersions
     )
 
-    if (-not $VersionsToBuild) { return }
+    if (-not $WhatsNewVersions) { return }
 
-    # Ensure API key exists before invoking Python helper
-    ThrowIfEmpty $Env:API_WEB_RAVENDB_NET_HOST 'API_WEB_RAVENDB_NET_HOST env var must be set when specifying versions'
+    ThrowIfEmpty $Env:WHATS_NEW_URL 'WHATS_NEW_URL env var must be set when specifying versions'
 
-    Write-Host "Generating *What's New* pages for versions: $($VersionsToBuild -join ', ')" -ForegroundColor Cyan
+    $VersionsArray = $WhatsNewVersions.Split(',') | ForEach-Object { $_.Trim() } | Where-Object { $_ }
+    Write-Host "Generating *What's New* pages for versions: $WhatsNewVersions" -ForegroundColor Cyan
 
-    & python $PythonWhatsNewPath @VersionsToBuild
+    & python $PythonWhatsNewPath @VersionsArray
     if ($LASTEXITCODE) { throw 'build_whats_new.py failed' }
 }
 
-# ---------------------------------------------------------------------------
-# 0. Verify runtime dependencies
-# ---------------------------------------------------------------------------
 Ensure-Dependencies
 
-# ---------------------------------------------------------------------------
-# 1. Validate AWS environment
-# ---------------------------------------------------------------------------
 ThrowIfEmpty $Env:AWS_ACCESS_KEY_ID      'AWS_ACCESS_KEY_ID not set'
 ThrowIfEmpty $Env:AWS_SECRET_ACCESS_KEY 'AWS_SECRET_ACCESS_KEY not set'
 ThrowIfEmpty $Env:AWS_DEFAULT_REGION    'AWS_DEFAULT_REGION not set'
 
 Write-Host "Region: '$Env:AWS_DEFAULT_REGION' | Bucket: '$S3BucketName'" -ForegroundColor Cyan
 
-# ---------------------------------------------------------------------------
-# 2. Validate API_WEB_RAVENDB_NET_HOST when versions are provided
-# ---------------------------------------------------------------------------
-if ($Versions.Count -gt 0) {
-    ThrowIfEmpty $Env:API_WEB_RAVENDB_NET_HOST 'API_WEB_RAVENDB_NET_HOST env var must be set when specifying versions'
+if ($Versions) {
+    ThrowIfEmpty $Env:WHATS_NEW_URL 'WHATS_NEW_URL env var must be set when specifying versions'
 }
 
-# ---------------------------------------------------------------------------
-# 3. Regenerate What's New (if requested)
-# ---------------------------------------------------------------------------
 Process-Changelogs -VersionsToBuild $Versions
 
-# ---------------------------------------------------------------------------
-# 4. Install JS dependencies & build site
-# ---------------------------------------------------------------------------
-Write-Host 'Installing JS dependencies (npm ci)…' -ForegroundColor Cyan
+Write-Host 'Installing JS dependencies (npm ci)...' -ForegroundColor Cyan
 $env:NODE_OPTIONS = '--max-old-space-size=8192'
 
 if (-not (Test-Path package.json)) { throw 'package.json not found' }
 
 npm ci --no-audit --fund false
 if ($LASTEXITCODE) { throw 'npm ci failed' }
 
-Write-Host "Running 'npx docusaurus build --dev'…" -ForegroundColor Gray
-npx docusaurus build --dev
+Write-Host "Running 'npx docusaurus build'..." -ForegroundColor Gray
+npx docusaurus build
 if ($LASTEXITCODE) { throw 'Docusaurus build failed' }
 
 $BuildDir = Join-Path $PSScriptRoot 'build'
@@ -138,16 +120,10 @@ if ($DryRun) {
     Write-Host "Dry run mode enabled. Skipping sync to s3://$S3BucketName/ and CloudFront invalidation." -ForegroundColor Yellow
 } else {
 
-    # ---------------------------------------------------------------------------
-    # 5. Sync build output to S3
-    # ---------------------------------------------------------------------------
-    Write-Host "Syncing to s3://$S3BucketName/ …" -ForegroundColor Cyan
+    Write-Host "Syncing to s3://$S3BucketName/ ..." -ForegroundColor Cyan
     aws s3 sync $BuildDir "s3://$S3BucketName/" --delete
     if ($LASTEXITCODE) { throw 'aws s3 sync failed' }
 
-    # ---------------------------------------------------------------------------
-    # 6. Invalidate CloudFront (optional)
-    # ---------------------------------------------------------------------------
     if ($CloudFrontDistributionId) {
         Write-Host "Invalidating CloudFront distribution $CloudFrontDistributionId" -ForegroundColor Cyan
         aws cloudfront create-invalidation --distribution-id $CloudFrontDistributionId --paths '/*' | Out-Null