Repository navigation
docs: describe repoplone-native distribution management - #137
Merged
Merged
Conversation
Update the distribution how-to guides to reflect the workflow now built into repoplone, replacing the project-local upgrade-distribution.js script: - ensure-versions-distribution-projects: enforcement is now driven by a generated frontend/distribution.json + .pnpmfile.cjs; embed the new pnpmfile and internal-check test contents. - upgrade-distribution-make-upgrade: the make upgrade target now runs 'uvx repoplone deps upgrade frontend'; document distribution.json output. - upgrade-distribution: note the automatic distribution.json regeneration. - release: document 'uvx repoplone deps stamp-volto-version' and its release-it after:bump hook for distribution packages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the distribution how-to guides to match the workflow now built into
repoplone(plone/repoplone#86), which replaces the project-localfrontend/scripts/upgrade-distribution.jsscript and moves the generated enforcement data from thevolto.config.jsdistributionkey into a dedicatedfrontend/distribution.json.Changes
ensure-versions-distribution-projects.md: rewritten. Enforcement is now driven by a generatedfrontend/distribution.jsonplusfrontend/.pnpmfile.cjs. Explains that RepoPlone auto-detects a distribution via its publishedvolto_versionfield, and embeds the up-to-date.pnpmfile.cjsand the optional internal-check test (both now readingdistribution.json). Removes theupgrade-distribution.jscopy step.upgrade-distribution-make-upgrade.md: themake upgradetarget now runsuvx repoplone deps upgrade frontend; the "what it does" section describes thedistribution.json/mrs.developer.jsonoutput and the.pnpmfile.cjsenforcement at install time.upgrade-distribution.md: adds a note that upgrading a distribution frontend also regeneratesdistribution.jsonand alignsmrs.developer.json.release.md: documentsuvx repoplone deps stamp-volto-versionand the.release-it.jsonafter:bumphook that stampsvolto_versionwhen releasing a distribution package.Verification
sphinx-buildcompletes with no new warnings or errors from the edited files (the only warnings are pre-existing external-link ones inindex.md).Follow-up (not in this PR)
The canonical reference files under
frontend/scripts/in this repo (upgrade-distribution.js,.pnpmfile.cjs,internalChecks.test.ts) and kitconcept-core's own frontend still use the oldvolto.config.jsflow; migrating them todistribution.jsonis a separate change.📚 Documentation preview 📚: https://kitconcept.core--137.org.readthedocs.build/