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

Allow filtering by version level #534

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Conversation

timothymcmackin
Copy link
Collaborator

The current dependency script alerts on any version difference up to the fixpack level. This change allows you to pass --major to show only places where dependencies are out of date by the major version or --minor for minor version.

For example, npm run check-dependencies -- --major octez prints this:

docs/tutorials/smart-rollup.md
Outdated: octez 19 < 21.2

Reviewed 154 files.

But npm run check-dependencies -- --minor octez prints this:

docs/developing/octez-client/accounts.md
Outdated: octez 21.1 < 21.2

docs/developing/octez-client/installing.md
Outdated: octez 21.1 < 21.2

docs/developing/octez-client/transactions.md
Outdated: octez 21.1 < 21.2

docs/tutorials/smart-rollup.md
Outdated: octez 19 < 21.2

Reviewed 154 files.

Copy link

vercel bot commented Jan 28, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-staging ✅ Ready (Inspect) Visit Preview Jan 28, 2025 4:18pm

Copy link
Collaborator

@NicNomadic NicNomadic left a comment

Choose a reason for hiding this comment

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

Nice result!

As a side node, I thought the UI was more robust in the past, didn't t check for unknown dependencies? Now it doesn't seem to warn in case of misspelled options and/or arguments:

tezos-developer-docs % npm run check-dependencies -- --blabla zvelt

lists all the outdated dependecies, without complaining about anything.

src/scripts/check_dependencies.mjs Show resolved Hide resolved
src/scripts/check_dependencies.mjs Outdated Show resolved Hide resolved
@timothymcmackin
Copy link
Collaborator Author

Nice result!

As a side node, I thought the UI was more robust in the past, didn't t check for unknown dependencies? Now it doesn't seem to warn in case of misspelled options and/or arguments:

tezos-developer-docs % npm run check-dependencies -- --blabla zvelt

lists all the outdated dependecies, without complaining about anything.

In this case you are passing an argument --blabla with the value zvelt and it's swallowing those. I'll add an error to catch unrecognized arguments. It still checks for unknown dependencies if you run something like npm run check-dependencies -- blabla zvelt.

Base automatically changed from set-dependencies to main January 28, 2025 16:05
@timothymcmackin
Copy link
Collaborator Author

Added error checking so it will fail if you pass an unknown -- argument or unknown tool name.

Copy link
Collaborator

@NicNomadic NicNomadic left a comment

Choose a reason for hiding this comment

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

LGTM

@timothymcmackin timothymcmackin merged commit 5f274f9 into main Jan 29, 2025
3 checks passed
@timothymcmackin timothymcmackin deleted the check-dependencies-settings branch January 29, 2025 13:26
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.

2 participants