Skip to content

Commit

Permalink
fix: remove src build from doc build flow (#10127)
Browse files Browse the repository at this point in the history
This PR removes the src build step from the docs build flow. 

Successful CI Run:
https://github.com/AztecProtocol/aztec-packages/actions/runs/11960317707

- I have verified that `/yarn-project/+scripts-prod` is only referenced
by `/docs/Earthfile` and does not have other dependences
- The actual doc build itself is covered by setting the yarn workspace +
inheriting `FROM +serve` within the current workflow (see below). `FROM
+serve` itself uses `COPY +build/build build`, which made a duplicate
request to build src (it appears src was being built twice).

```
deploy-preview:
  BUILD ../yarn-project/+scripts-prod
  ARG ENV
  ARG NETLIFY_AUTH_TOKEN
  ARG NETLIFY_SITE_ID
  ARG AZTEC_BOT_COMMENTER_GITHUB_TOKEN
  ARG PR
  FROM +serve
  COPY --dir ../yarn-project/+scripts-prod/usr/src/yarn-project /usr/src
  COPY ./netlify.toml .
  COPY ./deploy_preview.sh .
  RUN NETLIFY_AUTH_TOKEN=$NETLIFY_AUTH_TOKEN NETLIFY_SITE_ID=$NETLIFY_SITE_ID ./deploy_preview.sh $PR $AZTEC_BOT_COMMENTER_GITHUB_TOKEN

deploy-prod:
  BUILD ../yarn-project/+scripts-prod
  ARG NETLIFY_AUTH_TOKEN
  ARG NETLIFY_SITE_ID
  FROM +serve
  COPY ./netlify.toml .
  COPY ./deploy_prod.sh .
  RUN NETLIFY_AUTH_TOKEN=$NETLIFY_AUTH_TOKEN NETLIFY_SITE_ID=$NETLIFY_SITE_ID ./deploy_prod.sh
```
  • Loading branch information
stevenplatt authored Nov 22, 2024
1 parent dc528da commit fbfe1b1
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ serve:


deploy-preview:
BUILD ../yarn-project/+scripts-prod
BUILD ../yarn-project/+scripts-preview
ARG ENV
ARG NETLIFY_AUTH_TOKEN
ARG NETLIFY_SITE_ID
ARG AZTEC_BOT_COMMENTER_GITHUB_TOKEN
ARG PR
FROM +serve
COPY --dir ../yarn-project/+scripts-prod/usr/src/yarn-project /usr/src
COPY --dir ../yarn-project/+scripts-preview/usr/src/yarn-project /usr/src
COPY ./netlify.toml .
COPY ./deploy_preview.sh .
RUN NETLIFY_AUTH_TOKEN=$NETLIFY_AUTH_TOKEN NETLIFY_SITE_ID=$NETLIFY_SITE_ID ./deploy_preview.sh $PR $AZTEC_BOT_COMMENTER_GITHUB_TOKEN
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy_preview.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ DOCS_PREVIEW_URL=$(echo "$DEPLOY_OUTPUT" | grep -E "https://.*aztec-docs-dev.net
echo "Unique deploy URL: $DOCS_PREVIEW_URL"

cd ../yarn-project/scripts
AZTEC_BOT_COMMENTER_GITHUB_TOKEN=$AZTEC_BOT_COMMENTER_GITHUB_TOKEN PR_NUMBER=$PR_NUMBER DOCS_PREVIEW_URL=$DOCS_PREVIEW_URL yarn docs-preview-comment
AZTEC_BOT_COMMENTER_GITHUB_TOKEN=$AZTEC_BOT_COMMENTER_GITHUB_TOKEN PR_NUMBER=$PR_NUMBER DOCS_PREVIEW_URL=$DOCS_PREVIEW_URL yarn docs-preview-comment
9 changes: 6 additions & 3 deletions yarn-project/Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ build:
BUILD ../noir/+nargo
BUILD --pass-args ../noir-projects/+build
BUILD ../l1-contracts/+build
BUILD ../barretenberg/ts/+build
BUILD ../noir/+packages
FROM +deps

Expand All @@ -53,7 +52,6 @@ build:
RUN ./bootstrap.sh full
RUN cd ivc-integration && chmod +x run_browser_tests.sh && npx playwright install && npx playwright install-deps


build-dev:
FROM +build
SAVE ARTIFACT /usr/src /usr/src
Expand Down Expand Up @@ -243,11 +241,16 @@ end-to-end:
WORKDIR /usr/src/yarn-project/end-to-end
ENTRYPOINT ["yarn", "test"]

scripts-prod:
scripts-preview:
FROM +build
RUN yarn workspaces focus @aztec/scripts --production && yarn cache clean
SAVE ARTIFACT /usr/src /usr/src

scripts-prod:
FROM +deps
RUN yarn workspaces focus @aztec/scripts --production && yarn cache clean
SAVE ARTIFACT /usr/src /usr/src

all:
BUILD +aztec
BUILD +end-to-end
Expand Down

0 comments on commit fbfe1b1

Please sign in to comment.