Skip to content

docs(README): correct deploy claim; CI builds and pushes the image only#110

Merged
rubenhensen merged 1 commit into
mainfrom
fix/readme-release-deploy-claim
May 27, 2026
Merged

docs(README): correct deploy claim; CI builds and pushes the image only#110
rubenhensen merged 1 commit into
mainfrom
fix/readme-release-deploy-claim

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented May 26, 2026

Summary

Fixes #109. The README's Releasing section claimed the site is deployed automatically via GitHub Actions. That isn't true — .github/workflows/ci.yml only builds and pushes ghcr.io/encryption4all/postguard-docs:edge. The NGINX container on the production host serving docs.postguard.eu still has to pull the new edge tag and restart out of band.

Wording mirrors the equivalent honest paragraph already in docs/repos/postguard-outlook-addon.md:164.

Test plan

  • Read the new section and confirm it matches ci.yml (build + push only, no deploy step).
  • README.md-only change; no source files touched, so npm run docs:build is unaffected.

Closes #109

The Releasing section claimed the site is deployed automatically. CI
only builds and pushes ghcr.io/encryption4all/postguard-docs:edge;
the NGINX container on the production host still has to pull the new
tag and restart out of band. Mirrors the wording already in
docs/repos/postguard-outlook-addon.md.

Closes #109
@dobby-coder dobby-coder Bot marked this pull request as ready for review May 26, 2026 23:47
@dobby-coder dobby-coder Bot requested a review from rubenhensen May 26, 2026 23:47
@dobby-coder
Copy link
Copy Markdown
Contributor Author

dobby-coder Bot commented May 26, 2026

Rule-compliance pass found three PR-meta gaps (diff itself was already clean):

  • flip-drafts-after-ci: PR was draft with green CI; flipped to ready.
  • pr-review-assignments: no reviewer; assigned @rubenhensen (autonomous run default).
  • project-boards-as-tracker: not on board 1; added.

The missing PostGuard logo at the top of the README (per standardized-readmes) is pre-existing state and unrelated to this PR's scope (fixing the deploy claim, issue #109).

Copy link
Copy Markdown
Contributor Author

@dobby-coder dobby-coder Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM — would approve, but GitHub blocks self-review on this bot-authored PR.

Verified against .github/workflows/ci.yml: the workflow only builds and pushes the image (edge tag on main, pr-* on PRs, semver on tags) — there is no deploy step. New wording is accurate and mirrors the equivalent honest paragraph already in docs/repos/postguard-outlook-addon.md:164. Title is conventional-commit; closes #109. README-only change, build unaffected. Safe to merge.

@rubenhensen rubenhensen merged commit 91cc8dd into main May 27, 2026
2 checks passed
@rubenhensen rubenhensen deleted the fix/readme-release-deploy-claim branch May 27, 2026 07:01
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.

docs(README): claim of automatic deploy is wrong — CI only builds and pushes the image

1 participant