All propeller changes in a single commit

types

Author: chris-cooper

.github/dependabot.yml

@@ -0,0 +1,24 @@
+# Dependabot config file. Enables updates for internal packages and schedules checks outside of office hours.
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
+
+version: 2
+registries:
+  npm-npmjs: # Define registry for private access
+    type: npm-registry
+    url: https://registry.npmjs.org
+    token: ${{secrets.NPM_TOKEN}}
+
+updates:
+  # Keep npm dependencies up to date
+  - package-ecosystem: "npm"
+    directory: "/"
+    # Allow version updates for dependencies in these registries
+    registries:
+      - npm-npmjs
+    # Check the npm registry for updates on Sunday 7pm UTC / Monday 5am AEST. This should be out of
+    # office hours so as to not block CI but not too long before people wake up, in case the updates
+    # cause issues.
+    schedule:
+      interval: "weekly"
+      day: "sunday"
+      time: "19:00"

.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,32 @@
+# Automatically merge dependabot PRs that upgrade to patch or minor versions. Adapted from:
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions#enable-auto-merge-on-a-pull-request
+name: dependabot-auto-merge
+on: pull_request
+
+permissions:
+  pull-requests: write
+  contents: write
+
+jobs:
+  auto-merge-dependabot-pr:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Get Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Approve PR
+        run: gh pr review --approve "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Auto-merge Dependabot PR
+        if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/production-release-pr.yml

@@ -0,0 +1,23 @@
+# Automatically creates a Product Release PR when anything is committed to main.
+name: production-release-pr
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  create-draft-release-pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: auto-create-pr-action
+        uses: PropellerAero/auto-create-pr-action@master
+        env:
+          BRANCH_PREFIX: "main"
+          BASE_BRANCH: "main"
+          PULL_REQUEST_TITLE: "[Production Release]"
+          PULL_REQUEST_DRAFT: "false"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -7,6 +7,7 @@
 .DS_Store
 Thumbs.db
 .eslintcache
+.env
 
 /Apps/CesiumViewer/Gallery/gallery-index.js
 
@@ -27,12 +28,19 @@ Thumbs.db
 /Tools/jsdoc/cesium_template/static/styles/prism.css
 
 /node_modules
+/engine/node_modules/
+/widgets/node_modules/
+/packages/engine/node_modules
+/packages/widgets/node_modules
 npm-debug.log
 npm-debug.log.*
 package-lock.json
-yarn.lock
 
 # WebStorm user-specific
 .idea/workspace.xml
 .idea/tasks.xml
 .idea/shelf
+
+# Codeship
+deployment/secrets
+*.aes

.npmignore

@@ -36,5 +36,5 @@
 /ThirdParty
 /Tools
 /web.config
-
+/deployment
 Thumbs.db

README-PROPELLER.md

@@ -0,0 +1,44 @@
+git add # Updating the Propeller fork of Cesium
+
+"The best way in my eyes is, to rebase because that fetches the latest changes of the upstream branch and replay your work on top of that." - [Stefan Bauer](https://stefanbauer.me/articles/how-to-keep-your-git-fork-up-to-date)
+
+The ideal git history should have all Propeller modifications in a single most recent commit, followed by the full history from upstream CesiumGS.
+
+e.g.
+
+```
+commit c6fc9cb205e387781c5269b95e350f61a8815d08
+Author: Chris Cooper <chris@propelleraero.com>
+Date:   Mon Sep 21 15:19:02 2020 +1000
+
+    All the Propeller mods in a single commit
+
+commit da4ddc58830606d89f762dc7d79b3dfe4103c6d1
+Merge: 9c61508 6c0a0f8
+Author: Kevin Ring <kevin@kotachrome.com>
+Date:   Tue Sep 1 15:47:38 2020 +1000
+
+    Updates for 1.73 release
+
+...
+```
+
+To maintain this going forward, use a `git rebase`.
+
+```
+# Make sure your main branch is up to date
+git checkout main
+git pull
+
+# Fetch the upstream tags
+git fetch upstream --tags
+
+# Interactive rebase to the CesiumGS release tag
+# Squash all propeller commits into a single commit
+git rebase -i 1.74
+
+# Fix all the broken stuff :)
+
+# You've just re-written the history so you'll have to force
+git push origin main --force
+```

Specs/TypeScript/index.ts

@@ -99,7 +99,8 @@ import {
   WebMapServiceImageryProvider,
   WebMapTileServiceImageryProvider,
   writeTextToCanvas,
-} from "cesium";
+} from "@propelleraero/cesium-engine";
+//PROPELLER HACK
 
 // Verify ImageryProvider instances conform to the expected interface
 let imageryProvider: ImageryProvider;

ThirdParty.json

@@ -36,7 +36,7 @@
     "license": [
       "Apache-2.0"
     ],
-    "version": "3.0.3",
+    "version": "2.3.10",
     "url": "https://www.npmjs.com/package/dompurify",
     "notes": "dompurify is available as both MPL-2.0 OR Apache-2.0"
   },
@@ -45,7 +45,7 @@
     "license": [
       "Apache-2.0"
     ],
-    "version": "1.5.6",
+    "version": "1.5.3",
     "url": "https://www.npmjs.com/package/draco3d"
   },
   {

build.js

@@ -22,7 +22,8 @@ import { mkdirp } from "mkdirp";
 
 // Determines the scope of the workspace packages. If the scope is set to cesium, the workspaces should be @cesium/engine.
 // This should match the scope of the dependencies of the root level package.json.
-const scope = "cesium";
+//PROPELLER HACK
+const scope = "propelleraero";
 
 const require = createRequire(import.meta.url);
 const packageJson = require("./package.json");
@@ -262,14 +263,18 @@ const workspaceSourceFiles = {
  */
 function generateDeclaration(workspace, file) {
   let assignmentName = path.basename(file, path.extname(file));
-
   let moduleId = file;
   moduleId = filePathToModuleId(moduleId);
 
   if (moduleId.indexOf("Source/Shaders") > -1) {
     assignmentName = `_shaders${assignmentName}`;
   }
   assignmentName = assignmentName.replace(/(\.|-)/g, "_");
+  //PROPELLER HACK
+  if (workspace === "engine" || workspace === "widgets") {
+    return `export { ${assignmentName} } from '@${scope}/cesium-${workspace}';`;
+  }
+
   return `export { ${assignmentName} } from '@${scope}/${workspace}';`;
 }
 
@@ -283,6 +288,7 @@ export async function createCesiumJs() {
   // Iterate over each workspace and generate declarations for each file.
   for (const workspace of Object.keys(workspaceSourceFiles)) {
     const files = await globby(workspaceSourceFiles[workspace]);
+    //PROPELLER HACK
     const declarations = files.map((file) =>
       generateDeclaration(workspace, file)
     );
@@ -305,7 +311,6 @@ const workspaceSpecFiles = {
  */
 export async function createCombinedSpecList() {
   let contents = `export const VERSION = '${version}';\n`;
-
   for (const workspace of Object.keys(workspaceSpecFiles)) {
     const files = await globby(workspaceSpecFiles[workspace]);
     for (const file of files) {
@@ -608,7 +613,8 @@ const externalResolvePlugin = {
       };
     });
 
-    build.onResolve({ filter: /@cesium/ }, () => {
+    // PROPELLER HACK
+    build.onResolve({ filter: /@propelleraero/ }, () => {
       return {
         path: "Cesium",
         namespace: "external-cesium",
@@ -621,7 +627,10 @@ const externalResolvePlugin = {
         namespace: "external-cesium",
       },
       () => {
-        const contents = `module.exports = Cesium`;
+        //PROPELLER HACK
+        //const contents = `module.exports = Cesium`;
+        const contents = `module.exports = "@propelleraero/cesium"`;
+
         return {
           contents,
         };
@@ -864,6 +873,7 @@ export async function createIndexJs(workspace) {
 
   const files = await globby(workspaceSources);
   files.forEach(function (file) {
+    //PROPELLER HACK
     file = path.relative(`packages/${workspace}`, file);
 
     let moduleId = file;
@@ -879,6 +889,7 @@ export async function createIndexJs(workspace) {
     contents += `export { default as ${assignmentName} } from './${moduleId}.js';${EOL}`;
   });
 
+  //PROPELLER HACK
   await writeFile(`packages/${workspace}/index.js`, contents, {
     encoding: "utf-8",
   });
@@ -1048,7 +1059,7 @@ export const buildWidgets = async (options) => {
   // Generate Build folder to place build artifacts.
   mkdirp.sync("packages/widgets/Build");
 
-  // Create index.js
+  //PROPELLER HACK
   await createIndexJs("widgets");
 
   // Create SpecList.js
@@ -1168,7 +1179,6 @@ export async function buildCesium(options) {
   await copyWidgetsAssets(path.join(outputDirectory, "Widgets"));
 
   // Copy static assets to Source folder.
-
   await copyEngineAssets("Source");
   await copyFiles(
     ["packages/engine/Source/ThirdParty/**/*.js"],

codeship-services.yml

@@ -0,0 +1,22 @@
+builder:
+  encrypted_env_file: deployment/encrypted/build_args.sec
+  volumes:
+    - ./Build:/build/Build
+    - ./Source:/build/Source
+  build:
+    dockerfile: deployment/Dockerfile
+    encrypted_args_file: deployment/encrypted/build_args.sec
+
+
+dockercfg-production:
+  image: codeship/aws-ecr-dockercfg-generator
+  add_docker: true
+  encrypted_dockercfg_path: deployment/encrypted/dockerhub_dockercfg.sec
+  encrypted_env_file: deployment/encrypted/deploy_creds_production.sec
+
+publisher:
+  image: 621673481476.dkr.ecr.us-east-1.amazonaws.com/deploy-tools
+  volumes:
+    - .:/code-to-deploy
+  cached: true
+  encrypted_env_file: deployment/encrypted/deploy_creds_production.sec

codeship-steps.yml

@@ -0,0 +1,30 @@
+- name: Test
+  service: builder
+  encrypted_dockercfg_path: deployment/encrypted/dockerhub_dockercfg.sec
+  command: yarn test
+
+- name: Build
+  service: builder
+  encrypted_dockercfg_path: deployment/encrypted/dockerhub_dockercfg.sec
+  command: yarn release
+
+- name: Publish/Deploy
+  type: parallel
+  steps:
+  - name: Publish top level
+    tag: main
+    service: publisher
+    dockercfg_service: dockercfg-production
+    command: publish-javascript-package --code-dir . --git-tag-prefix propeller
+  
+  - name: Publish engine
+    tag: main
+    service: publisher
+    dockercfg_service: dockercfg-production
+    command: publish-javascript-package --code-dir /packages/engine
+
+  - name: Publish widget
+    tag: main
+    service: publisher
+    dockercfg_service: dockercfg-production
+    command: publish-javascript-package --code-dir /packages/widgets

deployment/Dockerfile

@@ -0,0 +1,26 @@
+FROM node:14 AS Builder
+
+ARG NPM_TOKEN
+
+# Configure git to use our custom credential helper that can use the $GITHUB_KEY env var
+# This allows us to use the github token without writing it to disk. The sleep is required
+# to avoid a race condition on some systems.
+# https://git-scm.com/docs/api-credentials#_credential_helpers
+
+ARG GITHUB_KEY
+
+RUN git config --global credential.helper "!f() { sleep 0.1; echo 'username=${GITHUB_KEY}\npassword=x-oauth-basic'; }; f" && git config --global url."https://github.com/".insteadOf "git@github.com:"
+
+WORKDIR /build
+
+# Move the package into the container
+COPY . /build
+
+# Configure yarn to use NPM registry
+RUN yarn config set registry "https://registry.npmjs.org"
+
+# Set authToken for access to @propelleraero/* packages.
+RUN npm config set "//registry.npmjs.org/:_authToken" ${NPM_TOKEN}
+
+# Dependencies
+RUN yarn install