Try to make deployment repos be strict mirrors of main-repo branches

Author: ethanjli

.github/workflows/deploy.yml .github/workflows/deploy-dev.yml.github/workflows/deploy.yml renamed to .github/workflows/deploy-dev.yml

@@ -1,4 +1,4 @@
-name: deploy
+name: deploy (dev)
 
 on:
   push:

.github/workflows/deploy-prod.yml

@@ -0,0 +1,39 @@
+name: deploy (prod)
+
+on:
+  push:
+    branches:
+      - 'prod'
+  workflow_call:
+  workflow_dispatch:
+
+env:
+  RELEASE_CHANNEL: prod
+  TARGET_REPO: ${{ vars.REPO }}
+  TARGET_BRANCH: deploy
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  deploy:
+    environment:
+      name: repo-prod
+      url: https://github.com/${{ env.REPO }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ env.RELEASE_CHANNEL }}
+
+      - name: Force-push to target repo
+        run: |
+          mkdir -p "$HOME/.ssh"
+          echo "${{ secrets.SSH_DEPLOY_KEY }}" > "$HOME/.ssh/deploy_key"
+          chmod 600 "$HOME/.ssh/deploy_key"
+          export GIT_SSH_COMMAND="ssh -i $HOME/.ssh/deploy_key"
+
+          git remote add sync-repo "git@github.com:${{ env.TARGET_REPO }}.git"
+          git branch -u "sync-repo/${{ env.TARGET_BRANCH }}"
+          git push --force

.github/workflows/deploy-staging.yml

@@ -0,0 +1,39 @@
+name: deploy (staging)
+
+on:
+  push:
+    branches:
+      - 'staging'
+  workflow_call:
+  workflow_dispatch:
+
+env:
+  RELEASE_CHANNEL: staging
+  TARGET_REPO: ${{ vars.REPO }}
+  TARGET_BRANCH: deploy
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  deploy:
+    environment:
+      name: repo-staging
+      url: https://github.com/${{ env.TARGET_REPO }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ env.RELEASE_CHANNEL }}
+
+      - name: Force-push to target repo
+        run: |
+          mkdir -p "$HOME/.ssh"
+          echo "${{ secrets.SSH_DEPLOY_KEY }}" > "$HOME/.ssh/deploy_key"
+          chmod 600 "$HOME/.ssh/deploy_key"
+          export GIT_SSH_COMMAND="ssh -i $HOME/.ssh/deploy_key"
+
+          git remote add sync-repo "git@github.com:${{ env.TARGET_REPO }}.git"
+          git branch -u "sync-repo/${{ env.TARGET_BRANCH }}"
+          git push --force

.github/workflows/release-channel-dev.yml

@@ -34,10 +34,10 @@ jobs:
         with:
           branch: staging
 
-  sync-repo-staging:
+  deploy-repo-staging:
     # We call this workflow manually because it doesn't appear to be triggered automatically by a
     # push of the dev branch from the ff-branch job:
-    uses: ./.github/workflows/sync-repo-staging.yml
+    uses: ./.github/workflows/deploy-staging.yml
     needs: ff-branch-staging
     secrets: inherit
 
@@ -58,9 +58,9 @@ jobs:
         with:
           branch: prod
 
-  sync-repo-prod:
+  deploy-repo-prod:
     # We call this workflow manually because it doesn't appear to be triggered automatically by a
     # push of the dev branch from the ff-branch job:
-    uses: ./.github/workflows/sync-repo-prod.yml
+    uses: ./.github/workflows/deploy-prod.yml
     needs: ff-branch-prod
     secrets: inherit

.github/workflows/release-channel-prod.yml

@@ -37,9 +37,9 @@ jobs:
         with:
           branch: prod
 
-  sync-repo:
+  deploy-repo:
     # We call this workflow manually because it doesn't appear to be triggered automatically by a
     # push of the prod branch from the ff-branch job:
-    uses: ./.github/workflows/sync-repo-prod.yml
+    uses: ./.github/workflows/deploy-prod.yml
     needs: ff-branch
     secrets: inherit

.github/workflows/release-channel-staging.yml

@@ -40,9 +40,9 @@ jobs:
         with:
           branch: staging
 
-  sync-repo:
+  deploy-repo:
     # We call this workflow manually because it doesn't appear to be triggered automatically by a
     # push of the staging branch from the ff-branch job:
-    uses: ./.github/workflows/sync-repo-staging.yml
+    uses: ./.github/workflows/deploy-staging.yml
     needs: ff-branch
     secrets: inherit

.github/workflows/sync-repo-prod.yml

@@ -32,26 +32,13 @@ Then open: <http://localhost:3000>
 The openUC2 docs site has three GitHub Pages deployments, each with its own repository:
 
 - development/edge release channel: the `master` branch of [openUC2/docs](https://github.com/openUC2/docs); deploys to [docs-dev.openuc2.com](https://docs-dev.openuc2.com).
-- staging/beta release channel: the `deploy` branch of [openUC2/docs-staging](https://github.com/openUC2/docs-staging); deploys to [docs-staging.openuc2.com](https://docs-staging.openuc2.com)
-- prod/stable release channel: the `deploy` branch of [openUC2/docs-prod](https://github.com/openUC2/docs-prod); deploys to [docs.openuc2.com](https://docs.openuc2.com).
-
-To set up a local development environment which can deploy to all three channels, run:
-
-```bash
-git clone git@github.com:openUC2/docs.git
-cd docs
-git config push.default upstream
-git remote add staging git@github.com:openUC2/docs-staging.git
-git remote add prod git@github.com:openUC2/docs-prod.git
-git fetch --all
-git checkout -b deploy/staging staging/deploy
-git checkout -b deploy/prod prod/deploy
-git checkout master
-```
+- staging/beta release channel: the `staging` branch of openUC2/docs; automatically mirrored to the `deploy` branch of [openUC2/docs-staging](https://github.com/openUC2/docs-staging), which deploys to [docs-staging.openuc2.com](https://docs-staging.openuc2.com)
+- prod/stable release channel: the `prod` branch of openUC2/docs; automatically mirrored to the `deploy` branch of [openUC2/docs-prod](https://github.com/openUC2/docs-prod), which deploys to [docs.openuc2.com](https://docs.openuc2.com).
 
-Then you can fast-forward your local `deploy/staging` and `deploy/prod` branches to the desired commits on your local `master` branch, and you can deploy changes to the staging and prod release channels by pushing your updated local `deploy/staging` and `deploy/prod` branches, respectively, up to GitHub.
+After cloning the openUC2/docs repo, then you can fast-forward your local `staging` and `prod` branches to the desired commits on your local `master` branch.
+Then you can deploy changes to the staging and prod release channels by pushing your updated local `staging` and `prod` branches, respectively, up to the openUC2/docs repository.
 The deployment process should usually be done as follows:
 
-1. Fast-forward the `deploy` branch of the `docs-staging` repo to whichever commit of the `docs` repo that we want to publish.
-2. Look at `docs-staging.openuc2.com` and fix any problems.
-3. Once the version in the `docs-staging` repo is stable and mature enough for publication, fast-forward the `deploy` branch of the `docs-prod` repo to the publication-ready commit of the `docs-staging` repo.
+1. Fast-forward the `staging` branch of the openUC2/docs repo to whichever commit of the `master` branch that we want to publish.
+2. Wait for it to build and deploy, then look at `docs-staging.openuc2.com` and fix any problems.
+3. Once the version in the `docs-staging` repo is stable and mature enough for publication, fast-forward the `prod` branch of the openUC2/docs repo to the publication-ready commit of the `staging` branch.