-
Notifications
You must be signed in to change notification settings - Fork 162
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.
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
feat(cli): add flag to disable update notifications #1740
Conversation
🦋 Changeset detectedLatest commit: 0e40999 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Thanks @ahmadnassri for the contribution! |
Thanks @ahmadnassri , this is a nice addition and it works as expected! We typically operate a zero-config convention where everything is |
can certainly change the behaviour. |
@lornajane updated the PR accordingly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ahmadnassri !
What/Why/How?
allow skipping update checks in the cli by setting
REDOCLY_SUPPRESS_UPDATE_NOTICE=true
, useful for local development mode / production environmentsthe format of
REDOCLY_SUPPRESS_UPDATE_NOTICE
borrows from npm'sNPM_CONFIG_UPDATE_NOTIFIER
for familiarity / consistency.Reference
Resolves #1639
Testing
no testing exists for this particular CLI path, so I did not include any additional tests.
Screenshots (optional)
N/A
Check yourself
Code changed? - Tested with redoc/reference-docs/workflows (internal)All new/updated code is covered with testsNew package installed? - Tested in different environments (browser/node)Security