Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Versioned deployments for documentation site #9642

Closed
6 tasks done
bo0tzz opened this issue May 21, 2024 · 0 comments
Closed
6 tasks done

Versioned deployments for documentation site #9642

bo0tzz opened this issue May 21, 2024 · 0 comments
Assignees
Labels
deployment Deployment related tasks documentation Improvements or additions to documentation

Comments

@bo0tzz
Copy link
Member

bo0tzz commented May 21, 2024

Currently, cloudflare pages automatically pulls and deploys the documentation site on every commit to main. This has been an annoyance with needing to hold off on merging documentation PRs until after a release to avoid confusion. This issue lays out a path to resolve this and pick up a few other shiny things along the way.

The plan is to have the following deployments on cloudflare pages (they call each a "branch"). Each of these lives on its own subdomain under immich.pages.dev.

  • feat-foo, deployed for every PR that makes changes to docs/*.
  • main, deployed for every push to main that makes changes to docs/*.
  • vfoo and release, deployed in the release workflow.

We manually set up custom domains in CF pages for immich.app -> release.immich.pages.dev and main.immich.app -> main.immich.pages.dev. All other deployments are accessed directly on the pages.dev hosts.

Tasks

@bo0tzz bo0tzz added documentation Improvements or additions to documentation deployment Deployment related tasks labels May 21, 2024
@bo0tzz bo0tzz closed this as completed Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployment Deployment related tasks documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants