Skip to content

Document when a deploy updates the root config entry - #682

Merged
kriszyp merged 2 commits into
mainfrom
docs/root-config-activation-effect
Sep 25, 2026
Merged

kriszyp merged 2 commits into
mainfrom
docs/root-config-activation-effect

Conversation

@dawsontoth

@dawsontoth dawsontoth commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Documents when deploy_component changes a component's entry in the root harper-config.yaml, for HarperFast/harper#2789 (harper#2315 step 3).

  • Operations reference: a new "How a deploy updates the root config" section under deploy_component. It covers that the entry changes only once the new release is live on that node, and that startup settles an interrupted deploy's entry with its tree. It also gives what each kind of deploy does to the entry: a package deploy replaces it, a payload deploy removes package, install and credentials and keeps the rest, and drop_component removes it. The writes are serialized with set_configuration, and a deploy that has to change the entry is refused before anything changes when the root config does not parse or its directory is not writable.
  • 5.3 release notes: a "Root Config Follows the Live Release" entry, flagging the payload-deploy change as the behaviour operators will see.

Badged v5.3.0 (changed): the feature lands on main after v5.3.0-beta.2, and v5.3.0 is not cut.

Verification

npm run format:check and npm run build pass, and the preview deployment renders both pages, with the release note's link landing on the new section. The section describes what HarperFast/harper#2789 implements and tests: its end-to-end test, integrationTests/deploy/root-config-activation-effect.test.ts, covers each kind of deploy and drop_component, and its unit tests cover the serialization with set_configuration and the up-front refusal.

🤖 Generated with Claude Code

A component's root-config entry now changes only once its new release is
live, a payload deploy removes package/install/credentials from it, and
startup settles an interrupted deploy's entry with its tree
(HarperFast/harper#2315 step 3). Documents that on deploy_component and
adds a 5.3 release note.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation and release notes for version 5.3.0 to explain how a deployment updates the root configuration file (harper-config.yaml) only after a release goes live. Feedback was provided to format the list of deployment types in operations.md using bold-led terms and em dashes to maintain consistency with the repository's prose list style.

Comment thread reference/operations-api/operations.md Outdated
@github-actions
github-actions Bot temporarily deployed to pr-682 September 24, 2026 22:09 Inactive
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-682

This preview will update automatically when you push new commits.

…he rest of the page

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-682

This preview will update automatically when you push new commits.

@github-actions
github-actions Bot temporarily deployed to pr-682 September 25, 2026 01:57 Inactive
@dawsontoth
dawsontoth marked this pull request as ready for review September 25, 2026 03:27
@dawsontoth
dawsontoth requested a review from a team as a code owner September 25, 2026 03:27
@kriszyp
kriszyp merged commit e3d3321 into main Sep 25, 2026
16 checks passed
@kriszyp
kriszyp deleted the docs/root-config-activation-effect branch September 25, 2026 13:51
@github-actions

Copy link
Copy Markdown

🧹 Preview Cleanup

The preview deployment for this PR has been removed.

This branch was previously deployed

1 inactive deployment
pr-682 — 69aa7327 Deployed Sep 25, 2026 by github-actions[bot]
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.

2 participants