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

Show error page if embed version out of supported range #335

Merged
merged 3 commits into from
Feb 26, 2024

Conversation

ericglau
Copy link
Member

@ericglau ericglau commented Feb 23, 2024

In our documentation sites, we embed Wizard for different versions of the Contracts libraries, for example on https://docs.openzeppelin.com/contracts-cairo/0.9.0/wizard

However, Wizard is only compatible with specific versions of the libraries, which is specified (and shown on Wizard) as a semantic version string.

In the embeddings, we should allow passing through a version parameter for the selected version of the documentation. If this version is outside of the compatible versions, the embed will show an error page instead of the actual Wizard. By doing this, we will no longer need to manually remove Wizard from older versions of the doc sites.

This version can be passed in from a documentation page like this:

<oz-wizard style="display: block; min-height: 40rem;" data-lang="cairo" version="0.8.0"></oz-wizard>

Example result:
https://deploy-preview-335--openzeppelin-contracts-wizard.netlify.app/embed?lang=cairo&version=0.8.0

Copy link

socket-security bot commented Feb 23, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@nomicfoundation/[email protected] environment Transitive: eval, filesystem, network, shell, unsafe +544 200 MB fvictorio
npm/@nomicfoundation/[email protected] environment Transitive: eval, filesystem, network, shell, unsafe +506 164 MB fvictorio
npm/@openzeppelin/[email protected] filesystem Transitive: environment, eval, network, shell, unsafe +231 94.1 MB ericglau

🚮 Removed packages: npm/@alloc/[email protected], npm/@babel/[email protected], npm/@isaacs/[email protected], npm/@jridgewell/[email protected], npm/@jridgewell/[email protected], npm/@pkgjs/[email protected], npm/@polka/[email protected], npm/@popperjs/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@rollup/[email protected], npm/@trysound/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/@types/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

@ericglau ericglau marked this pull request as ready for review February 23, 2024 21:43
Copy link
Member

@ericnordelo ericnordelo left a comment

Choose a reason for hiding this comment

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

Looking great Eric!

@ericglau ericglau merged commit dc9e3e3 into OpenZeppelin:master Feb 26, 2024
9 checks passed
@ericglau ericglau deleted the embedversion branch February 26, 2024 14:54
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