Skip to content

Commit 2154d5e

Browse files
authored
chore(docs): Update docs bootrap to to include release (#13615)
- This PR re-enables docs builds and release when running the corresponding bootstrap commands. - The deploy docs action now calls `/docs/bootstrap.sh release`. - removes the typesense action since it has been added to the deploy-docs action
1 parent c00b20b commit 2154d5e

File tree

4 files changed

+18
-38
lines changed

4 files changed

+18
-38
lines changed

.github/workflows/docs-deploy.yml

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,8 @@ jobs:
4444
4545
# Making the bash script here so we don't accidentally deploy
4646
- name: Deploy docs
47-
working-directory: ./docs
4847
run: |
49-
echo "deploying docs to prod"
50-
yarn install
51-
yarn build
52-
53-
if ! deploy_output=$(yarn netlify deploy --site aztec-docs-dev --prod 2>&1); then
54-
echo "Netlify deploy failed with error:"
55-
echo "$deploy_output"
56-
exit 1
57-
fi
48+
./docs/bootstrap.sh release
5849
5950
- name: Reindex with Typesense docsearch-scraper
6051
run: |

.github/workflows/reindex-typesense.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

bootstrap.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ function build {
197197
yarn-project
198198
boxes
199199
playground
200-
# docs
200+
docs
201201
release-image
202202
spartan
203203
aztec-up
@@ -248,7 +248,7 @@ function release {
248248
# + noir
249249
# + yarn-project => NPM publish to dist tag, version is our REF_NAME without a leading v.
250250
# aztec-up => upload scripts to prod if dist tag is latest
251-
# docs, playground => publish if dist tag is latest. TODO Link build in github release.
251+
# playground => publish if dist tag is latest. TODO Link build in github release.
252252
# release-image => push docker image to dist tag.
253253
# boxes/l1-contracts => mirror repo to branch equal to dist tag (master if latest). Also mirror to tag equal to REF_NAME.
254254

@@ -270,7 +270,7 @@ function release {
270270
boxes
271271
aztec-up
272272
playground
273-
# docs
273+
# docs # released here /.github/workflows/docs-deploy.yml
274274
release-image
275275
)
276276
if [ $(arch) == arm64 ]; then

docs/bootstrap.sh

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ function build_docs {
3232
cache_upload docs-$hash.tar.gz build
3333
}
3434

35+
function release_docs {
36+
echo "deploying docs to prod"
37+
yarn install
38+
yarn build
39+
40+
if ! deploy_output=$(yarn netlify deploy --site aztec-docs-dev --prod 2>&1); then
41+
echo "Netlify deploy failed with error:"
42+
echo "$deploy_output"
43+
exit 1
44+
fi
45+
}
46+
3547
case "$cmd" in
3648
"clean")
3749
git clean -fdx
@@ -42,8 +54,8 @@ case "$cmd" in
4254
"hash")
4355
echo "$hash"
4456
;;
45-
"release-preview")
46-
release_preview
57+
"release")
58+
release_docs
4759
;;
4860
*)
4961
echo "Unknown command: $cmd"

0 commit comments

Comments
 (0)