Skip to content

    Development documentation — this describes the current development branch. Documented behavior may not exist in the latest release.

    Upgrades

    This page covers keeping a deployment current: container image tags, Helm chart upgrades, and how this fork relates to upstream releases.

    • An existing container or Helm deployment (see Deployment).
    TagBehaviorRecommended for
    latestMoves with each build from main.Trying the newest build; non-critical use.
    sha-<commit>Immutable; always the same image.Persistent and production-like deployments.

    For a stable deployment, pin an immutable sha-<commit> tag and update it deliberately:

    Terminal window
    docker pull ghcr.io/forgeguard-ai/markdown-live-preview:sha-<commit>
    Terminal window
    docker compose pull # or: docker pull <image>:<tag>
    docker compose up -d

    Because the app is stateless (all user state lives in the visitor’s browser), upgrades do not require data migration. Users keep their locally stored content and settings.

    Terminal window
    helm upgrade --install markdown-live-preview \
    oci://ghcr.io/forgeguard-ai/helm-charts/markdown-live-preview --version <chart-version> \
    --set image.tag=<image-tag>

    The chart version and the image tag are independent. Pin both for reproducibility. Verify after upgrading:

    Terminal window
    kubectl rollout status deploy/markdown-live-preview

    This fork tracks upstream tagged releases of tanabe/markdown-live-preview and reapplies the ForgeGuard privacy, container, and Helm changes on top. New upstream features are not automatically present; see Fork compatibility for current divergences, and Migration from upstream if you are moving from an upstream build.

    Terminal window
    curl --fail http://localhost:8080/