Rhythm 2.0 Specifications

Appearance

JNY-WEB-WEB-004An administrator publishes design work with staff review when required

Markdown

JNY-WEB-WEB-004

An administrator publishes design work with staff review when required

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-WEB-WEB-04
Actor
ACT-WEB-001
Capabilities
CAP-WEB-WEB-011, CAP-WEB-WEB-012, CAP-WEB-WEB-013, CAP-WEB-WEB-014, CAP-WEB-WEB-015
Rules in play
BR-CAP-WEB-WEB-012-03, BR-CAP-WEB-WEB-012-05, BR-CAP-WEB-WEB-013-02, BR-CAP-WEB-WEB-014-01, BR-CAP-WEB-WEB-014-04, BR-CAP-WEB-WEB-014-05, BR-CAP-WEB-WEB-014-06, BR-CAP-WEB-WEB-015-03

KindJourneyProduct areaWebsitesModuleWebsites, content and the portal runtimeRevision1End-to-endOptional

Read atservices-websites 5fc6823c

An administrator publishes design work with staff review when required ​

Story ​

An administrator wants a reusable design to reflect revised branding. They open recorded work, save a stylesheet revision and inspect its protected preview. The administrator confirms the revision they reviewed, after which checks and workflow reports determine progress. Sensitive alterations introduce a separate Rhythm staff decision. The examined service tests establish revision-bound merge and recorded delivery outcomes; rendering on a real deployment remains a distinct operational proof.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Goal
Revise a reusable design, inspect its protected preview and confirm the precise work intended for release.
Screens
/console/{tenantId}/websites/templates/console/{tenantId}/websites/templates/{templateId}/edit

Steps

#SurfaceActionCapabilityExpectedProvenance
1openWebTemplateChangeRequest a change against a workspace template.CAP-WEB-WEB-011The service records Queued work on the change's branch.observed
services-websites:modules/changes/services/templates/template-ops.ts:openTemplateChange
2persistWebsiteChangeRevisionSave the stylesheet revision.CAP-WEB-WEB-012The change branch advances without moving the release branch.test
services-websites:modules/changes/tests/integration/services/revisions/persist-revision.integration.spec.js#leaves the release branch at the commit it was at
3getWebsiteChangePreviewLinkFollow the change's protected preview link.CAP-WEB-WEB-013The current revision's protected deployment opens for review.test
services-websites:modules/changes/tests/integration/services/preview/preview-link.integration.spec.js#redirects a click to the deployment of the current revision with a fresh share, waiting for the edge to honour it
4publishWebsiteChangeConfirm that revision for publication.CAP-WEB-WEB-014Self-service work opens a pull request and waits for its checks.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#answers that the publish waits for the checks, with the pull request it opened
5receiveWebsiteStudioCallbackReceive successful publication reports from the workflow.CAP-WEB-WEB-015The change record becomes Live and identifies its release.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#ends live, linked to the release the workflow recorded

Alternate and Failure Paths

PathFrom stepConditionPath takenOutcomeProvenance
alternate4The requested work also changes dependencies.Rhythm staff review and approve the matching revision.Merge waits for that staff approval.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#merges at exactly the approved revision once staff approve it
failure5A required publication check fails.The change records the check failure without merging.The preceding production release is retained and eligible recovery follows the retry rules.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#leaves the customer’s production deployment on its prior release

Assertions

IdStatementProvenance
01The merge contains precisely the administrator's confirmed revision.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#merges at exactly the confirmed revision once the checks pass
02Failed checks leave the release branch and production at their earlier state.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#merges nothing: master is where it was and the pull request is still open
03Sensitive work dispatches publication only after staff approval of the same revision.test
services-websites:modules/changes/tests/integration/services/publish/publish.integration.spec.js#dispatches studio-publish only after the approval

End-to-end policy: optional: The former design browser journeys are retired pending Configuration planning; service tests exercise repository and hosting doubles, while a live deployment rehearsal needs its dedicated workspace.

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software