Centralize env vars in env; Refactor deployment checks

ggetz · ggetz · commit d771cf02b7b2 · 2025-10-13T15:49:35.000-04:00
diff --git a/.env b/.env
@@ -0,0 +1,17 @@
+# Get the current git values from GitHub Action variables if triggered from pull-reqest or push; otherwise fallback to the current local git branch
+BRANCH="$(git branch --show-current)"
+BRANCH=${PULL_REQUEST_HEAD_REF:-${GITHUB_REF_NAME:-${BRANCH}}}
+COMMIT_SHA="$(git rev-parse HEAD)"
+COMMIT_SHA=${PULL_REQUEST_HEAD_SHA:-${GITHUB_SHA:-${COMMIT_SHA}}}
+
+# Read the Cesium version from package.json
+CESIUM_VERSION=$(npm pkg get version | tr -d '"')
+
+# Build artifact configuration
+BUILD_ARTIFACT_BUCKET="cesium-public-builds"
+BUILD_ARTIFACT_URL="https://ci-builds.cesium.com/cesium/${BRANCH}"
+
+INDEX_URL="${BUILD_ARTIFACT_URL}/index.html"
+ZIP_URL="${BUILD_ARTIFACT_URL}/Cesium-${CESIUM_VERSION}.zip"
+NPM_URL="${BUILD_ARTIFACT_URL}/cesium-${CESIUM_VERSION}.tgz"
+COVERAGE_URL="${BUILD_ARTIFACT_URL}/Build/Coverage/index.html"
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -14,16 +14,12 @@ jobs:
       statuses: write
       contents: read
     env:
-      BUILD_VERSION: ${{ github.ref_name }}.${{ github.run_number }}
       AWS_ACCESS_KEY_ID: ${{ secrets.DEV_AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.DEV_AWS_SECRET_ACCESS_KEY }}
       AWS_REGION: us-east-1
-      BRANCH: ${{ github.ref_name }}
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      GITHUB_REPO: ${{ github.repository }}
       GITHUB_SHA: ${{ github.sha }}
       BASE_URL: /cesium/${{ github.ref_name }}/
-      DEPLOYED_URL: https://ci-builds.cesium.com/cesium/${{ github.ref_name }}/
     steps:
       - uses: actions/checkout@v5
       - name: install node 22
@@ -32,8 +28,16 @@ jobs:
           node-version: '22'
       - name: npm install
         run: npm install
-      - name: set the version in package.json
-        run: npm run deploy-set-version -- --buildVersion $BUILD_VERSION
+      - name: set version in package.json
+        run: |
+          npx @dotenvx/dotenvx run -- sh -c \
+          'npm version prerelease --preid $BRANCH --ws --include-workspace-root --no-git-tag-version'
+      - name: set status pending
+        if: ${{ env.AWS_ACCESS_KEY_ID != '' }}
+        run: |
+          node ./scripts/setDeployStatus.js zip pending
+          node ./scripts/setDeployStatus.js npm pending
+          node ./scripts/setDeployStatus.js index pending
       - name: create release zip
         run: npm run make-zip
       - name: package cesium module
@@ -48,7 +52,8 @@ jobs:
       - name: deploy to s3
         if: ${{ env.AWS_ACCESS_KEY_ID != '' }}
         run: |
-          aws s3 sync . s3://cesium-public-builds/cesium/$BRANCH/ \
+          npx @dotenvx/dotenvx run -- sh -c \
+          'aws s3 sync . s3://$BUILD_ARTIFACT_BUCKET/cesium/$BRANCH/ \
           --cache-control "no-cache" \
           --exclude ".git/*" \
           --exclude ".github/*" \
@@ -61,7 +66,10 @@ jobs:
           --exclude "node_modules/*" \
           --exclude "scripts/*" \
           --exclude "Tools/*" \
-          --delete
-      - name: set status
+          --delete'
+      - name: set status success
         if: ${{ env.AWS_ACCESS_KEY_ID != '' }}
-        run: npm run deploy-status -- --status success --message Deployed
+        run: |
+          node ./scripts/setDeployStatus.js zip ${{ job.status }}
+          node ./scripts/setDeployStatus.js npm ${{ job.status }}
+          node ./scripts/setDeployStatus.js index ${{ job.status }}
diff --git a/.github/workflows/dev.yml b/.github/workflows/dev.yml
@@ -30,8 +30,12 @@ jobs:
       AWS_ACCESS_KEY_ID: ${{ secrets.DEV_AWS_ACCESS_KEY_ID }}
       AWS_SECRET_ACCESS_KEY: ${{ secrets.DEV_AWS_SECRET_ACCESS_KEY }}
       AWS_REGION: us-east-1
-      BRANCH: ${{ github.ref_name }}
-      DEPLOYED_URL: https://ci-builds.cesium.com/cesium/${{ github.ref_name }}/
+      PULL_REQUEST_HEAD_SHA: ${{ github.event.pull_request && github.event.pull_request.head.sha || '' }}
+      PULL_REQUEST_HEAD_REF: ${{ github.event.pull_request && github.event.pull_request.head.ref || '' }}
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      statuses: write
+      contents: read
     steps:
       - uses: actions/checkout@v5
       - name: install node 22
@@ -40,13 +44,19 @@ jobs:
           node-version: '22'
       - name: npm install
         run: npm install
+      - name: set status pending
+        if: ${{ env.AWS_ACCESS_KEY_ID != '' }}
+        run: node ./scripts/setDeployStatus.js coverage pending
       - name: build
         run: npm run build
       - name: coverage (firefox)
         run: npm run coverage -- --browsers FirefoxHeadless --webgl-stub --failTaskOnError --suppressPassed
       - name: upload coverage artifacts
         if: ${{ env.AWS_ACCESS_KEY_ID != '' }}
-        run: aws s3 sync ./Build/Coverage s3://cesium-public-builds/cesium/$BRANCH/Build/Coverage --delete --color on
+        run: npx @dotenvx/dotenvx run -- sh -c 'aws s3 sync ./Build/Coverage s3://$BUILD_ARTIFACT_BUCKET/cesium/$BRANCH/Build/Coverage --delete --color on'
+      - name: set status success
+        if: ${{ env.AWS_ACCESS_KEY_ID != '' }}
+        run: node ./scripts/setDeployStatus.js coverage ${{ job.status }}
   release-tests:
     runs-on: ubuntu-latest
     steps:
diff --git a/.github/workflows/prod.yml b/.github/workflows/prod.yml
@@ -29,7 +29,6 @@ jobs:
       AWS_REGION: us-east-1
       BRANCH: ${{ github.ref_name }}
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      GITHUB_REPO: ${{ github.repository }}
       GITHUB_SHA: ${{ github.sha }}
     steps:
       - uses: actions/checkout@v5
diff --git a/.github/workflows/sandcastle-dev.yml b/.github/workflows/sandcastle-dev.yml
@@ -13,7 +13,6 @@ jobs:
       AWS_REGION: us-east-1
       BRANCH: ${{ github.ref_name }}
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      GITHUB_REPO: ${{ github.repository }}
       GITHUB_SHA: ${{ github.sha }}
     steps:
       - uses: actions/checkout@v5
diff --git a/Documentation/Contributors/BuildGuide/README.md b/Documentation/Contributors/BuildGuide/README.md
@@ -153,6 +153,3 @@ Here's the full set of scripts and what they do.
   - `test-webgl-stub` - Runs all tests using the WebGL stub, which WebGL calls a noop and ignores related test expectations
   - `test-webgl-validation` - Runs all tests with Karma and enables low-level WebGL validation
   - `test-release` - Runs all tests on the minified release version of built Cesium
-- **Deployment scripts**
-  - `deploy-status` - Sets the deployment statuses in GitHub, for use in CI
-  - `deploy-set-version` - Sets the version of `package.json`, for use in CI
diff --git a/Documentation/Contributors/ContinuousIntegration/README.md b/Documentation/Contributors/ContinuousIntegration/README.md
@@ -18,51 +18,42 @@ CesiumJS uses [GitHub Actions](https://docs.github.com/en/actions) for continuou
 
 Reusable actions are defined in `/.github/actions/` and workflows in `.github/workflows/`.
 
-A workflow is triggered whenever someone pushes code to the CesiumJS repository, or an external contributor opens a pull request. After the build has completed, at the bottom of the pull request page the status of the build is shown. In the dropdown menu, individual checks are displayed. Logs and deployed artifacts can be accessed by clicking the "Details" link.
+Workflows are triggered when a commit is pushed to the `cesium` repository and when a contributor opens or updates a pull request. After the build has completed, the overall status of the build is shown at the bottom of the pull request page.
+
+In the dropdown menu, individual status checks are displayed. Logs and deployed build artifacts can be accessed by clicking the link associated with the individual check.
 
 ![GitHub Action Checks](github_action_checks.png)
 
-The workflow checks for any CesiumJS branch are accessible under the [Branches](https://github.com/CesiumGS/cesium/branches/all) page by clicking the icon next to the branch name.
+The status checks for any branch are also accessible under the [Branches](https://github.com/CesiumGS/cesium/branches/all) page by clicking the icon next to the branch name.
 
 ![GitHub Branches](github_branches.png)
 
 ## Continuous deployment
 
-Automated deployments make recent code changes available for testing and review without needing to fetch and build locally. We deploy each of the following on a per-branch basis.
+Automated deployments make recent code changes available for convenient testing and review—No need to fetch or build locally. In the `cesium` repository, all continuous deployment artifacts are uploaded for commits authored by users with commit access.
+
+Each of the following are deployed on a per-branch basis.
 
-| Artifact         | Link (`main` branch)                                                                                                                                                       |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Sandcastle       | [`https://ci-builds.cesium.com/cesium/main/Apps/Sandcastle/index.html`](https://ci-builds.cesium.com/cesium/main/Apps/Sandcastle/index.html)                               |
-| Documentation    | [`https://ci-builds.cesium.com/cesium/main/Build/Documentation/index.html`](https://ci-builds.cesium.com/cesium/main/Build/Documentation/index.html)                       |
-| Coverage results | [`https://ci-builds.cesium.com/cesium/main/Build/Coverage/index.html`](https://ci-builds.cesium.com/cesium/main/Build/Coverage/index.html)                                 |
-| Release zip      | [`https://ci-builds.cesium.com/cesium/main/<github-ref-name>.<github-run-number>.zip`](https://ci-builds.cesium.com/cesium/main/<github-ref-name>.<github-run-number>.zip) |
-| npm package      | [`https://ci-builds.cesium.com/cesium/main/<github-ref-name>.<github-run-number>.tgz`](https://ci-builds.cesium.com/cesium/main/<github-ref-name>.<github-run-number>.tgz) |
+| Artifact         | Link pattern (`main`)                                                                                                                                                                                                                      |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Sandcastle       | `https://ci-builds.cesium.com/cesium/<BRANCH>/Apps/Sandcastle/index.html` (i.e., [`https://ci-builds.cesium.com/cesium/main/Apps/Sandcastle/index.html`](https://ci-builds.cesium.com/cesium/main/Apps/Sandcastle/index.html))             |
+| Documentation    | `https://ci-builds.cesium.com/cesium/<BRANCH>/Build/Documentation/index.html` (i.e., [`https://ci-builds.cesium.com/cesium/main/Build/Documentation/index.html`](https://ci-builds.cesium.com/cesium/main/Build/Documentation/index.html)) |
+| Coverage results | `https://ci-builds.cesium.com/cesium/<BRANCH>/Build/Coverage/index.html` (i.e., [`https://ci-builds.cesium.com/cesium/main/Build/Coverage/index.html`](https://ci-builds.cesium.com/cesium/main/Build/Coverage/index.html))                |
+| Release zip      | `https://ci-builds.cesium.com/cesium/<BRANCH>/Cesium-<VERSION>-<BRANCH>.0.zip` (i.e., [`https://ci-builds.cesium.com/cesium/main/Cesium-1.X.X-main.0.zip`](https://ci-builds.cesium.com/cesium/main/Cesium-1.X.X-main.0.zip))              |
+| npm package      | `https://ci-builds.cesium.com/cesium/<BRANCH>/cesium-<VERSION>-<BRANCH>.0.tgz` (i.e., [`https://ci-builds.cesium.com/cesium/main/cesium-1.X.X-main.0.tgz`](https://ci-builds.cesium.com/cesium/main/cesium-1.X.X-main.0.tgz))              |
 
 ## Configuration
 
-Additional set up is required for deployment if you do not have commit access to CesiumJS.
+Additional set up is required for deployment _only_ if you do not have commit access to CesiumJS.
 
 ### Configure a different S3 bucket
 
-It is possible to configure your development branch of CesiumJS to deploy build artifacts to a different [AWS S3 Bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html). If you are using the cesium-public-builds bucket and have valid credentials, skip to [Configure S3 Credentials](#configure-s3-credentials)
-
-- In `.gtihub/workflows/dev.yml`, in the following lines, replace "cesium-public-builds" with the name of your S3 bucket.
-
-```sh
-aws s3 sync ./Build/Coverage s3://cesium-public-builds/cesium/$BRANCH/Build/Coverage --delete --color on
-```
-
-```sh
-aws s3 sync Build/unzipped/ s3://cesium-public-builds/cesium/$BRANCH/Build/ --cache-control "no-cache" --delete
-```
-
-- In `gulpfile.js`, edit the following line:
+It is possible to configure your development branch of CesiumJS to deploy build artifacts to a different [AWS S3 Bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html). If you are using the default "cesium-public-builds" bucket and have valid credentials, skip to [Configure S3 Credentials](#configure-s3-credentials)
 
-```javascript
-const devDeployUrl = "https://ci-builds.cesium.com/cesium/";
-```
+In the environment file `.env`, update the following values:
 
-- Edit the URL to match the URL hosting the S3 bucket specified in the previous step.
+- Replace the value of `BUILD_ARTIFACT_BUCKET` with the name of the target S3 bucket.
+- Replace the value of `BUILD_ARTIFACT_URL` with the public URL correspondeding to the target S3 bucket.
 
 ### Configure S3 credentials
 
diff --git a/gulpfile.js b/gulpfile.js
@@ -2,7 +2,6 @@ import { writeFileSync, copyFileSync, readFileSync, existsSync } from "fs";
 import { readFile, writeFile } from "fs/promises";
 import { join, basename, resolve, dirname } from "path";
 import { exec, execSync } from "child_process";
-import fetch from "node-fetch";
 import { createRequire } from "module";
 import { finished } from "stream/promises";
 
@@ -39,7 +38,8 @@ const scope = "cesium";
 const require = createRequire(import.meta.url);
 const packageJson = require("./package.json");
 let version = packageJson.version;
-if (/\.0$/.test(version)) {
+if (/\.\d+\.0$/.test(version)) {
+  // Removes the patch release ".0" at the end of any non-prelease version
   version = version.substring(0, version.length - 2);
 }
 const karmaConfigFile = resolve("./Specs/karma.conf.cjs");
@@ -54,7 +54,6 @@ function getWorkspaces(onlyDependencies = false) {
     : packageJson.workspaces;
 }
 
-const devDeployUrl = process.env.DEPLOYED_URL;
 const isProduction = process.env.PROD;
 
 //Gulp doesn't seem to have a way to get the currently running tasks for setting
@@ -554,8 +553,6 @@ async function pruneScriptsForZip(packageJsonPath) {
   delete scripts.prettier;
 
   // Remove deploy tasks
-  delete scripts["deploy-status"];
-  delete scripts["deploy-set-version"];
   delete scripts["website-release"];
 
   // Set server tasks to use production flag
@@ -698,66 +695,6 @@ export const makeZip = gulp.series(release, async function createZipFile() {
   return src;
 });
 
-export async function deploySetVersion() {
-  const buildVersion = argv.buildVersion;
-  if (buildVersion) {
-    // NPM versions can only contain alphanumeric and hyphen characters
-    packageJson.version += `-${buildVersion.replace(/[^[0-9A-Za-z-]/g, "")}`;
-    return writeFile("package.json", JSON.stringify(packageJson, undefined, 2));
-  }
-}
-
-export async function deployStatus() {
-  const status = argv.status;
-  const message = argv.message;
-  const deployUrl = `${devDeployUrl}`;
-  const zipUrl = `${deployUrl}Cesium-${version}.zip`;
-  const npmUrl = `${deployUrl}cesium-${version}.tgz`;
-  const coverageUrl = `${deployUrl}Build/Coverage/index.html`;
-
-  return Promise.all([
-    setStatus(status, deployUrl, message, "deploy / artifact: deployment"),
-    setStatus(status, zipUrl, message, "deploy / artifact: zip file"),
-    setStatus(status, npmUrl, message, "deploy / artifact: npm package"),
-    setStatus(
-      status,
-      coverageUrl,
-      message,
-      "deploy / artifact: coverage results",
-    ),
-  ]);
-}
-
-async function setStatus(state, targetUrl, description, context) {
-  // skip if the environment does not have the token
-  if (!process.env.GITHUB_TOKEN) {
-    return;
-  }
-
-  const body = {
-    state: state,
-    target_url: targetUrl,
-    description: description,
-    context: context,
-  };
-
-  const response = await fetch(
-    `https://api.github.com/repos/${process.env.GITHUB_REPO}/statuses/${process.env.GITHUB_SHA}`,
-    {
-      method: "post",
-      body: JSON.stringify(body),
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `token ${process.env.GITHUB_TOKEN}`,
-        "User-Agent": "Cesium",
-      },
-    },
-  );
-
-  const result = await response.json();
-  return result;
-}
-
 /**
  * Generates coverage report.
  *
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/CesiumGS/cesium.git"
+    "url": "git+https://github.com/CesiumGS/cesium.git"
   },
   "bugs": {
     "url": "https://github.com/CesiumGS/cesium/issues"
@@ -56,6 +56,7 @@
   },
   "devDependencies": {
     "@cesium/eslint-config": "^12.0.0",
+    "@dotenvx/dotenvx": "^1.51.0",
     "@playwright/test": "^1.41.1",
     "chokidar": "^4.0.1",
     "cloc": "^2.6.0-cloc",
@@ -95,7 +96,6 @@
     "markdownlint-cli": "^0.45.0",
     "merge-stream": "^2.0.0",
     "mkdirp": "^3.0.1",
-    "node-fetch": "^3.2.10",
     "open": "^10.0.2",
     "prettier": "3.6.2",
     "prismjs": "^1.28.0",
@@ -139,8 +139,6 @@
     "test-e2e-release-all": "release=true playwright test -c Specs/e2e/playwright.config.js",
     "test-e2e-report": "playwright show-report Build/Specs/e2e/report",
     "test-e2e-update": "playwright test -c Specs/e2e/playwright.config.js --project=chromium -u",
-    "deploy-status": "gulp deployStatus",
-    "deploy-set-version": "gulp deploySetVersion",
     "prettier": "prettier --write \"**/*\"",
     "prettier-check": "prettier --check \"**/*\"",
     "cspell": "npx cspell lint -c .vscode/cspell.json --unique --no-progress"
diff --git a/scripts/setDeployStatus.js b/scripts/setDeployStatus.js
