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

Cairo: use release branches instead of tags #419

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

ericnordelo
Copy link
Member

This should work out of the box since each release has a release branch.

Copy link
Contributor

@ggonzalez94 ggonzalez94 left a comment

Choose a reason for hiding this comment

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

@ericnordelo this looks good.

  • I think we are missing one release branch that is in the docs site(0.15.0-rc.0). I don't think this is a big issue, so I think we are ok removing this
  • There are a few release branches that we don't have published in the docs and would appear now(0.2.0, 0.2.1, 0.7.0-rc.0). Here I suggest we solve this issue first.

Also would be great if we can get a preview before pushing this changes. I think @ericglau has to trigger the workflow?

@ericnordelo
Copy link
Member Author

I removed the release candidates, beta releases, and release branches previous to v0.7.0 (cairo 0) from the cairo-contracts repository. Waiting for the deploy-preview as pointed by @ggonzalez94

ericglau
ericglau previously approved these changes Oct 22, 2024
Copy link
Member

@ericglau ericglau left a comment

Choose a reason for hiding this comment

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

Preview is deployed

@ericnordelo
Copy link
Member Author

ericnordelo commented Oct 22, 2024

Updated to doc branches instead, since we already use release branches for bumping the version on releases, and sometimes the docsite may be updated before the release is finished. cc @ggonzalez94

We have to add a doc branch to each corresponding version before merging this.

@ericnordelo
Copy link
Member Author

Added a doc branch for every release after 0.10.0 and merged ERC20Permit doc into docs-v0.18.0. Is there a way to re-launch the deploy preview @ericglau? @ggonzalez94 waiting for your confirmation to merge in case you prefer a different approach.

@ericglau
Copy link
Member

Redeploy failed with error:

9:18:02 AM: [13:18:02.273] FATAL (antora): Duplicate nav in 0.12.0@contracts-cairo: modules/ROOT/nav.adoc
9:18:02 AM:   1: docs/modules/ROOT/nav.adoc in https://github.com/OpenZeppelin/cairo-contracts (ref: docs-v0.12.0)
9:18:02 AM:   2: docs/modules/ROOT/nav.adoc in https://github.com/OpenZeppelin/cairo-contracts (ref: docs-v0.13.0)

@ericnordelo
Copy link
Member Author

Whoops. Version conflicts fixed @ericglau.

@ericglau
Copy link
Member

ericglau commented Oct 23, 2024

Redeployment succeeded at https://deploy-preview-419--openzeppelin-docs.netlify.app/
Build log here. It didn't refresh the github checks, but it looks fine to me.

@ericnordelo
Copy link
Member Author

@ggonzalez94 a kindly reminder that the sooner we merge this the sooner we get ERC20Permit entries in the docsite.

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.

3 participants