fix #387 - feat: Deploy released Editor versions to GitHub Pages

[fantonangeli]

Closes #387

❗ Actions required:

• Enable GH Pages
• Create an empty gh-pages branch
• Create these 2 repo vars under https://github.com/open-workflow-specification/editor/settings/variables/actions :

PREVIEW_PACKAGE_DIR=packages/open-workflow-diagram-editor 
PREVIEW_PACKAGE_NAME=@openworkflowspec/diagram-editor 

Description

Deploy released Editor versions to GitHub Pages.

Motivation

The Editor is currently deployed to Netlify from main.

This is useful for development and pull request previews, but the Open Workflow Specification website should link to a deployed released version of the Editor instead of showing unreleased changes from main.

Proposed Implementation

Deploy the Editor to GitHub Pages as part of the release process.

The deployment should:

• Build the Editor from the exact Git tag associated with the release, not from main.
• Be triggered as part of the release or publish workflow.
• Keep the deployments permanently available.

[netlify]

✅ Deploy Preview for openworkflow-editor ready!

Name	Link
🔨 Latest commit	e7dcc8c
🔍 Latest deploy log	https://app.netlify.com/projects/openworkflow-editor/deploys/6aa3dc645563dd0008369dd2
😎 Deploy Preview	https://deploy-preview-393--openworkflow-editor.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[Copilot]

🟡 Changes recommended

Workflow validation, initial branch setup, retry behavior, and broken root links currently block reliable deployment.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds versioned Storybook deployments to GitHub Pages as part of releases.

Changes:

• Adds reusable Pages deployment workflow.
• Connects deployment to publishing.
• Documents release URLs and manual deployment.

File summaries

File	Description
.github/workflows/deploy-pages.yaml	Builds tagged releases and deploys versioned Storybooks.
.github/workflows/publish-release.yaml	Triggers Pages deployment after publishing.
RELEASE_PROCESS.md	Documents deployment behavior.
README.md	Links to released editor.
packages/open-workflow-diagram-editor/README.md	Adds released-editor link.

Review details

Suppressed comments (2)

.github/workflows/deploy-pages.yaml:87

• The initial deployment cannot reach the build because this checkout requires gh-pages to exist, but the repository currently has no such branch. Please either initialize the branch as part of this workflow or provision and document it as a prerequisite before enabling the release job.

      - name: Checkout gh-pages
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          ref: gh-pages
          path: pages

.github/workflows/deploy-pages.yaml:105

• A redeploy of an unchanged version exits here because git commit returns status 1 when there are no staged changes. In particular, if a prior run pushed the branch and then failed during Pages deployment, the documented retry will fail before uploading; allow a no-op commit while still proceeding to deployment.

          git commit -s -m "deploy: ${DEPLOY_PREVIEW_PACKAGE_NAME}@${{ inputs.version }}"

• Files reviewed: 5/5 changed files
• Comments generated: 4
• Review effort level: Balanced

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[fantonangeli]

.github/workflows/deploy-pages.yaml:105

* A redeploy of an unchanged version exits here because `git commit` returns status 1 when there are no staged changes. In particular, if a prior run pushed the branch and then failed during Pages deployment, the documented retry will fail before uploading; allow a no-op commit while still proceeding to deployment.

          git commit -s -m "deploy: ${DEPLOY_PREVIEW_PACKAGE_NAME}@${{ inputs.version }}"

This is intentional. If there are no changes to commit, git commit will fail with nothing to commit, working tree clean, and the failure will be visible in the CI run logs.

[Copilot]

🟡 Changes recommended

Release deployment is blocked by incompatible setup and Changesets inputs, while no-op redeployments can fail.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

• Files reviewed: 9/9 changed files
• Comments generated: 3
• Review effort level: Balanced

[Copilot]

🟡 Changes recommended

The deployment currently fails during cache setup and exposes an unsafe manual version input to privileged shell commands.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

• Files reviewed: 9/9 changed files
• Comments generated: 2
• Review effort level: Balanced

[Copilot]

🟡 Changes recommended

Pages enablement is missing from rollout setup, and concurrency can silently skip overlapping version deployments.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

.github/workflows/deploy-pages.yaml:48

• This does not fully serialize deployments: GitHub Actions retains at most one pending run per concurrency group and cancels an older pending run when another arrives, even with cancel-in-progress: false. If three releases or manual backfills overlap, the middle version is never added to gh-pages, contradicting the requirement to retain every release. Use a queue that preserves every run, or detect/retry canceled version deployments while still preventing concurrent branch pushes.

• Files reviewed: 9/9 changed files
• Comments generated: 1
• Review effort level: Balanced

[lornakelly]

@fantonangeli Thanks, looks really nice, and simpler to the way I had it :)

Just added a couple of comments. I will work on actions listed in PR description as well

[lornakelly]

LGTM

[Copilot]

🟡 Changes recommended

The concurrency configuration can skip deployments or regress the latest pointer when releases overlap.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Review details

• Files reviewed: 9/9 changed files
• Comments generated: 1
• Review effort level: Balanced

[lornakelly]

Confirming that @fantonangeli and I completed the actions required section of the PR

[Copilot]

🔵 Needs a closer look

The /latest/ links need an initial backfill because gh-pages is empty and automatic deployment awaits a future release.

Review details

Suppressed comments (1)

Previously missed (1) — in code that hasn't changed since the last review.

README.md:24

• The new public link will still return 404 after this merges: the gh-pages branch is currently empty, while the automatic deployment only runs after a future release PR publishes. Please include an initial workflow_dispatch backfill of 1.1.0 with latest=true in the rollout (or seed /latest/ before exposing these links), otherwise every newly added “latest” link remains broken until the next release.

• Files reviewed: 9/9 changed files
• Comments generated: 0 new
• Review effort level: Balanced

[fantonangeli]

@lornakelly can you please merge this