search

OpenZeppelin / cairo-contracts

OpenZeppelin Contracts written in Cairo for Starknet, a decentralized ZK Rollup
https://docs.openzeppelin.com/contracts-cairo
MIT License
797 stars 321 forks source link

Pass library version to Wizard in docs #928

Closed ericglau closed 4 months ago

ericglau commented 4 months ago

🧐 Motivation Wizard is only compatible with specific versions of this library, and this is shown on Wizard as a semantic version string.

When accessing Wizard from the documentation site, if the selected version of the library is not compatible with Wizard, we should show an appropriate error message.

📝 Details For each branch where Wizard is available, pass through a version parameter of the current library version when embedding Wizard. This will cause Wizard to render an error page if that version is not supported.

Related to: https://github.com/OpenZeppelin/contracts-wizard/pull/335

ericglau commented 4 months ago

This was addressed in the main and release branches, but the changes for the release branches do not appear in the docs site because the docs site is using version tags due to https://github.com/OpenZeppelin/cairo-contracts/issues/869.

@martriay Would it make sense to migrate the version tags again for these branches, similar to https://github.com/OpenZeppelin/cairo-contracts/issues/869#issuecomment-1935230841 ?

martriay commented 4 months ago

We've learned the hard way it could be problematic to re-tag versions. We need to re-release releases because they're automatically drafted when a tag is deleted. We should probably define a process for re tagging and document it, especially for hotfix releases.

martriay commented 4 months ago

Well apparently the releases are only drafted if the tag is deleted, but I just force pushed new tags and it worked perfectly.

ericglau commented 4 months ago

Thanks! This is resolved now.