update docs with release create --required flag in CLI#3790
Merged
alicenstar merged 4 commits intomainfrom Jan 27, 2026
Merged
Conversation
alicenstar
added
type::feature
type::docs
✅ 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. |
laverya
reviewed
Jan 26, 2026
Co-authored-by: Andrew Lavery <laverya@umich.edu>
laverya
previously approved these changes
Jan 26, 2026
paigecalvert
approved these changes
Jan 27, 2026
Contributor
paigecalvert
left a comment
paigecalvert
left a comment
There was a problem hiding this comment.
lgtm! some small changes, details in the comments
| * `CHANNEL` is the channel ID or the case sensitive name of the channel. | ||
|
|
||
| For a complete list of options for the command, see [release create](/reference/replicated-cli-release-create). | ||
|
|
Contributor
There was a problem hiding this comment.
^ note: I replaced the example with a link to the CLI command reference page where users can see all the options. This just helps avoid cluttering step-by-step procedures with too many options
| replicated release create [flags] | ||
| ``` | ||
|
|
||
| ### Examples |
Contributor
There was a problem hiding this comment.
These replicated cli docs are automatically generated when a new version of the CLI is released
So, these changes lgtm, but they'll be overwritten with whatever's in the cli help text
|
|
||
| * Use the `--release-notes` flag to include detailed release notes in markdown. | ||
|
|
||
| * For release versions that must not be skipped during upgrades (such as versions that include a required database migration), use the `--required` flag to mark the release as required. This flag can be used with both `release create --promote` and `release promote` commands. For more information about required releases, see [Required Releases](/vendor/releases-about#required-releases) in _About Channels and Releases_. |
alicenstar
deleted the
alicenstar/sc-133212/release-create-command-should-also-support
branch
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
4 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.
Shortcut story: https://app.shortcut.com/replicated/story/133212/release-create-command-should-also-support-required-flag-if-promoted-flag-used
We have a PR to un-hide the
release create--requiredflag, which already existed (and works), but was hidden from the CLI docs. This updates the product documentation as well.https://deploy-preview-3790--replicated-docs.netlify.app/reference/replicated-cli-release-create