Skip to content

Website publish workflows - #5

Merged
planger merged 4 commits into
mainfrom
feat/website-publish-workflows
Jul 28, 2026
Merged

planger merged 4 commits into
mainfrom
feat/website-publish-workflows

Conversation

@planger

@planger planger commented Jul 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds GitHub Actions workflows to publish the website (website/) to GitHub Pages
and deploy per-PR previews, adapting the four-workflow pattern used by the Theia
website repos. The key difference from Theia: the sources live in this repo but
must publish to the separate enclave-website / enclave-website-previews repos,
so production uses a cross-repo branch push + legacy Pages (the same mechanism
Theia already uses for previews) rather than an in-repo deploy-pages.

What's included

  • website/build.sh — shared assembly: copies the static marketing site to
    public/, builds the Docusaurus docs with an injected DOCS_BASE_URL, and
    places them at public/docs/.
  • website-publish.yml — on push to main (website/**), builds with
    DOCS_BASE_URL=/enclave/docs/ and pushes public/ to enclave-website:gh-pages.
  • website-preview-build.yml — on PR (no secrets, untrusted context), builds
    with the per-PR base path and uploads site + pr-metadata artifacts.
  • website-preview-deploy.yml — workflow_run (trusted) pushes the preview to
    enclave-website-previews:previews and comments the URL on the PR.
  • website-preview-remove.yml — on PR close, removes the preview.

All third-party actions are SHA-pinned; license headers pass; the build is verified
end-to-end locally (marketing site + docs with the correct /enclave/docs/ base URL).

⚠️ Requires org configuration before it works

Draft because the workflows depend on org config that is not yet in place:

Otterdog changes (separate PR against eclipse-enclave/.eclipsefdn):

  1. enclave-website: gh_pages_build_type: "legacy" + gh_pages_source_branch: "gh-pages" + gh_pages_source_path: "/".
  2. enclave repo: declare secrets DEPLOY_TOKEN and DEPLOY_PREVIEW_TOKEN.
  3. Optional cleanup of Theia-leftover env/branch policies on enclave-website.

Eclipse Foundation help desk:

  • Two tokens stored in the EF pass store: bots/ecd.enclave/github.com/publish-token
    (→ DEPLOY_TOKEN, push to enclave-website) and
    bots/ecd.enclave/github.com/preview-token
    (→ DEPLOY_PREVIEW_TOKEN, push to enclave-website-previews).

Production is served at eclipse.dev/enclave via the EF reverse proxy (base path
/enclave/); previews at
eclipse-enclave.github.io/enclave-website-previews/pr-previews/pr-<N>/.

@planger
planger marked this pull request as draft July 20, 2026 17:20
@planger planger changed the title Feat/website publish workflows ci: website publish and PR preview workflows Jul 20, 2026
@planger planger changed the title ci: website publish and PR preview workflows Website publish workflows Jul 20, 2026
@planger

planger commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

Otterdog changes: eclipse-enclave/.eclipsefdn#3

Comment thread .github/workflows/website-preview-deploy.yml
Comment thread .github/workflows/website-preview-build.yml
planger added 4 commits July 28, 2026 21:59
The Eclipse Foundation provisioned a single org-level DEPLOY_TOKEN instead of
separate publish and preview secrets. Grant the preview deploy job actions:read
so it can fetch artifacts from the build run, and allow overriding the docs base
path on a manual publish to test a deployment before eclipse.dev/enclave exists.
@planger
planger force-pushed the feat/website-publish-workflows branch from 580d4c5 to d44605b Compare July 28, 2026 20:10
@planger
planger marked this pull request as ready for review July 28, 2026 20:14
@planger
planger merged commit e7551a2 into main Jul 28, 2026
5 checks passed
@planger
planger deleted the feat/website-publish-workflows branch July 28, 2026 20:17
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-07-28 20:18 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants