Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): background check documentation update #11599

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(docs): background check documentation update #11599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/docs/app-configuration-redwood-toml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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",
      ),
    )
  }

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


To opt out of background version checks entirely, simply remove the `versionUpdates` option, comment it out, or set its value to an empty array `[""]`.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is me guessing here on ways to disable this. I have not tested these! 🙏


## Using Environment Variables in `redwood.toml`

Expand Down
12 changes: 7 additions & 5 deletions docs/docs/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2279,10 +2279,12 @@ yarn redwood upgrade -t 0.19.3

The CLI can check for things in the background, like new versions of the framework, while you dev.

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.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Right now it defaults to check for a new `latest` version.
Right now it defaults to check for a new "latest" version.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "checking" is the more correct form of the verb here 🙂

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.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Tags listed earlier in the array have priority.

By default, the CLI won't check for upgrades—you have to opt into it.
You can opt out of the background check process.

You'll see this notification once a day at most. And the CLI will check for it once a day at most. So, nothing heavy-handed going on here.
You'll see this notification once a day at most. And the CLI will check for an upgrade once a day, at most. So, nothing heavy-handed going on here.

For more details, see the [TOML configuration section in the documentation](app-configuration-redwood-toml.md#cli).
Loading