Skip to content

chore: Use released code for publishing docs #3754

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.

Sign up for GitHub

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

Closed
spalladino wants to merge 1 commit into from
Closed

chore: Use released code for publishing docs #3754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 24 additions & 15 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -853,24 +853,25 @@ jobs:
name: "Copy docs dockerignore"
command: cp docs/.dockerignore .
- run:
name: "Configure build for master"
command: |
if [ "$CIRCLE_BRANCH" == "master" ]; then
echo "Configuring build for master"
echo "INCLUDE_RELEASED_CODE=1" >> docs/.env
fi
- run:
name: "Build docs"
name: "Build docs using latest code"
command: build docs

deploy-docs:
machine:
image: ubuntu-2204:2023.07.2
resource_class: large
steps:
- *checkout
- *setup_env
- run:
name: "Copy docs dockerignore"
command: cp docs/.dockerignore .
- run:
name: "Build master docs using released code published in dockerhub"
command: build docs Dockerfile.prod
- run:
name: "Deploy docs"
command: |
if [ "$CIRCLE_BRANCH" == "master" ]; then
echo "Deploying docs (on master)."
docs/deploy_netlify.sh
else
echo "Skipping doc deploy (not on master)."
fi
command: docs/deploy_netlify.sh

yellow-paper:
machine:
Expand Down Expand Up @@ -928,6 +929,7 @@ jobs:
deploy_dockerhub cli
deploy_dockerhub aztec-faucet
deploy_dockerhub mainnet-fork
deploy_dockerhub l1-contracts
- run:
name: "Release canary to NPM: yarn-project"
command: |
Expand Down Expand Up @@ -1215,3 +1217,10 @@ workflows:

# Production releases.
- deploy-and-release: *defaults_deploy
- deploy-docs:
requires:
- deploy-and-release
filters:
branches:
only: master
Comment on lines +1223 to +1225
Copy link
Contributor Author

@spalladino spalladino Dec 20, 2023 •
edited
Loading

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

<<: *defaults
14 changes: 14 additions & 0 deletions build_manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,20 @@ docs:
dependencies:
- yarn-project

docs-prod:
buildDir: .
dockerfile: docs/Dockerfile.prod
rebuildPatterns:
- ^docs/
- ^.*.cpp$
- ^.*.hpp$
- ^.*.ts$
- ^.release-please-manifest.json$
- ^.*/noir-version.json$
- ^.*.nr$
dependencies:
- yarn-project

yellow-paper:
buildDir: yellow-paper
rebuildPatterns:
Expand Down
6 changes: 6 additions & 0 deletions docs/Dockerfile.prod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
FROM aztecprotocol/l1-contracts AS l1-contracts
FROM aztecprotocol/aztec-sandbox
COPY --from=l1-contracts /usr/src/l1-contracts /usr/src/l1-contracts
WORKDIR /usr/src/docs
COPY ./docs .
RUN yarn && yarn build