docs(ep): automating EPv2 content-branch creation (matches reusable-workflows#23) - #4431
Draft
kriscoleman wants to merge 1 commit into
Draft
docs(ep): automating EPv2 content-branch creation (matches reusable-workflows#23)#4431kriscoleman wants to merge 1 commit into
kriscoleman wants to merge 1 commit into
Conversation
Add an 'Automating content branch creation' section to the EPv2 versioned docs page covering the reusable epv2-reconcile-content-branches workflow: the bare-version branch-name contract, a copy-paste caller snippet, when branches are cut, and cleanup expectations. Matches replicatedhq/reusable-workflows#23. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
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
2 participants
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
This documents the automation for the per-release content branches Enterprise Portal v2 needs, so vendors stop hand-creating them (and stop 404-ing customers when they forget one). It's the docs half of replicatedhq/reusable-workflows#23, which ships the reusable workflow itself.
Merge in lockstep with replicatedhq/reusable-workflows#23. The caller snippet and the input names here mirror that PR's README, and the GitHub links point at
main, so they only resolve once #23 lands. Draft until then.Changes
Adds an "Automating content branch creation" section to
docs/vendor/enterprise-portal-v2-versioned-docs.mdx, right after "Adding versions" (where the page already tells vendors the branches are manual). It covers:0.3.312, notv0.3.312,release/0.3.312, or anything with build metadata or a pre-release suffix). Until now that rule only lived in the vendor API source.epv2-reconcile-content-branchesreusable workflow and its README.uses:line, the requiredworkflow_ref(pinned to the same ref), thereplicated_api_tokensecret,permissions: contents: write, and arelease: [published]trigger with a cron fallback.mainas it stands when reconcile runs, so run it at release time if you want the branch to match what shipped.MAJOR.MINOR.PATCHrequirement, so vendors onv-prefixed or calver schemes know it won't work as-is.UAT
npm ci && npm run build(Docusaurus). Build succeeds, exit 0.#removing-versionslink resolves. No broken-link or broken-anchor warnings reference this page in the build log.