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.

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

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

Conversation

ahmadnassri
Copy link

@ahmadnassri ahmadnassri commented Sep 19, 2024

What/Why/How?

allow skipping update checks in the cli by setting REDOCLY_UPDATE_NOTIFIER=false, useful for local development mode / production environments

the format of REDOCLY_UPDATE_NOTIFIER borrows from npm's NPM_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 tests
  • New package installed? - Tested in different environments (browser/node)

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@ahmadnassri ahmadnassri requested a review from a team as a code owner September 19, 2024 17:40
Copy link

changeset-bot bot commented Sep 19, 2024

🦋 Changeset detected

Latest commit: 8eb7a52

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@redocly/cli Patch
@redocly/openapi-core Patch

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

@tatomyr
Copy link
Contributor

tatomyr commented Sep 20, 2024

Thanks @ahmadnassri for the contribution!
@lornajane, could you take a look at the naming/behaviour when you have time?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suppress update now logging
2 participants