chore(docs): background check documentation update #11599
Conversation
This file contains 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
pantheredeye
commented
Sep 22, 2024
| If you'd like to get notified (at most, once a day) when there's a new version, set `versionUpdates` to an array of the version tags you're interested in (tags listed earlier take priority). | ||
| While you can specify any tag, common options include: `latest`, `canary`, `next`, or `rc`. | ||
|
|
||
| To opt out of background version checks entirely, simply remove the `versionUpdates` option, comment it out, or set its value to an empty array `[""]`. |
There was a problem hiding this comment.
This is me guessing here on ways to disable this. I have not tested these! 🙏
pantheredeye
changed the title
|
Also - I am waiting for approval/any modifications and then I will update and port back to v6(?). |
pantheredeye
commented
Sep 22, 2024
| Right now it can only check for new versions. | ||
| If you'd like it to do so, set `notifications.versionUpdates` in the `redwood.toml` file to include an array of the tags you're interested in hearing about. | ||
| (The former has priority.) | ||
| Right now it defaults to check for a new `latest` version. |
There was a problem hiding this comment.
Suggested change
| Right now it defaults to check for a new `latest` version. | |
| Right now it defaults to check for a new "latest" version. |
There was a problem hiding this comment.
I think "checking" is the more correct form of the verb here 🙂
pantheredeye
commented
Sep 22, 2024
| If you'd like it to do so, set `notifications.versionUpdates` in the `redwood.toml` file to include an array of the tags you're interested in hearing about. | ||
| (The former has priority.) | ||
| Right now it defaults to check for a new `latest` version. | ||
| To customize this behavior - perhaps by checking for `rc` (release candidate) or other tags - set `notifications.versionUpdates` in the `redwood.toml` file to include an array of the tags you're interested in. |
There was a problem hiding this comment.
Suggested change
| To customize this behavior - perhaps by checking for `rc` (release candidate) or other tags - set `notifications.versionUpdates` in the `redwood.toml` file to include an array of the tags you're interested in. | |
| To customize this behavior - perhaps by checking for "rc" (release candidate) or other tags - set `notifications.versionUpdates` in the `redwood.toml` file to include an array of the tags you're interested in. |
pantheredeye
commented
Sep 22, 2024
| @@ -165,7 +165,10 @@ These options allows you to disable the generation of test and story files. | |||
| There are new versions of the framework all the time—a major every couple months, a minor every week or two, and patches when appropriate. | |||
| And if you're on an experimental release line, like canary, there's new versions every day, multiple times. | |||
|
|
|||
| If you'd like to get notified (at most, once a day) when there's a new version, set `versionUpdates` to include the version tags you're interested in. | |||
| If you'd like to get notified (at most, once a day) when there's a new version, set `versionUpdates` to an array of the version tags you're interested in (tags listed earlier take priority). | |||
| While you can specify any tag, common options include: `latest`, `canary`, `next`, or `rc`. | |||
There was a problem hiding this comment.
Suggested change
| While you can specify any tag, common options include: `latest`, `canary`, `next`, or `rc`. | |
| While you can specify any tag, common options include: "latest", "canary", "next", or "rc" "experimental", or a valid semver version. |
These notes exist in the upgrade.js file... if these are all still valid tags, then I will update this PR to the above suggestion.
.option('tag', {
alias: 't',
description:
'[choices: "latest", "rc", "next", "canary", "experimental", or a specific-version (see example below)] WARNING: "canary", "rc" and "experimental" are unstable releases! And "canary" releases include breaking changes often requiring codemods if upgrading a project.',
requiresArg: true,
type: 'string',
coerce: validateTag,
})
and
if (!isTagValid) {
// Stop execution
throw new Error(
c.error(
"Invalid tag supplied. Supported values: 'rc', 'canary', 'latest', 'next', 'experimental', or a valid semver version\n",
),
)
}
There was a problem hiding this comment.
If you're going with your suggestion Barrett there are a couple of small tweaks I'd do to it. Right now there are two "or", and a missing comma.
With those corrections it'd look like this:
While you can specify any tag, common options include: "latest", "canary", "next", "rc", "experimental", or a valid semver version.
I'll let @Josh-Walker-GM comment on the validity of all those choices
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated the documentation around automated background checks to reflect that it is
latest,canary,next, orrcThis information spans two documents. Since the two documents interact, I added a link from the background check section to the TOML configuration section.