-
Notifications
You must be signed in to change notification settings - Fork 224
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
chore: Use released code for publishing docs #3754
Conversation
Removes the need to set INCLUDE_RELEASED_CODE when building docs, and just builds off the published images of sandbox and l1-contracts on dockerhub.
filters: | ||
branches: | ||
only: master |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to change this for a branch check in each step of the job for consistency with deploy-and-release
Note that this doesn't work as-is since include-code macros need access to both released code and latest code (as a fallback). This only gives access to latest code. |
This is a quick and dirty fix to get docs to load released code snippets again. We should not need to pass the entire git repo to the build context to make it work, but it should buy us some time until we ship a proper solution (see #3754).
This is a quick and dirty fix to get docs to load released code snippets again. We should not need to pass the entire git repo to the build context to make it work, but it should buy us some time until we ship a proper solution (see #3754).
Comments from Charlie on this PR from back in the day, so they don't just sit on my Slack:
And also an issue with this approach:
|
…3761) This is a quick and dirty fix to get docs to load released code snippets again. We should not need to pass the entire git repo to the build context to make it work, but it should buy us some time until we ship a proper solution (see AztecProtocol#3754).
Closing in favor of #4928 |
Removes the need to set INCLUDE_RELEASED_CODE when building docs, and just builds off the published images of sandbox and l1-contracts on dockerhub. This ensures that the API reference we are generating is actually from the latest release and not from whatever's on master (which is a bug we have today).
Note that we keep the INCLUDE_RELEASED_CODE logic in our docs build script just to try it out locally.