From a6a85f975ccda03448842453ef803b4176f6f8fe Mon Sep 17 00:00:00 2001 From: Lucas Amaral Date: Mon, 19 May 2025 09:19:03 -0300 Subject: [PATCH 1/4] chore(ci): execute docusaurus from docker compose Signed-off-by: Lucas Amaral --- .github/workflows/docs-test.yml | 39 ++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/.github/workflows/docs-test.yml b/.github/workflows/docs-test.yml index ad9bce8..8ca164e 100644 --- a/.github/workflows/docs-test.yml +++ b/.github/workflows/docs-test.yml @@ -17,33 +17,46 @@ name: Docs Check on: pull_request: - branches: [ main ] + branches: [ main, 'test-*' ] push: - branches: [ main ] + branches: [ main, 'test-*' ] jobs: docusaurus-test: name: Docusaurus Build & Log + # Replace by docker image (or docker compose) runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 - with: - node-version: '18' - - - name: Install dependencies + - name: Build docusaurus container run: | cd docusaurus/ - yarn install --frozen-lockfile - - - name: Build and test Docusaurus + docker compose -f docker-compose.yml build dev + # consider using caddy or serve + - name: Start docusaurus container run: | cd docusaurus/ - yarn test - + docker compose -f docker-compose.yml up -d dev + # consider using caddy or serve + - name: Wait for docusaurus to start + run: | + echo "Waiting for Docusaurus to start..." + sleep 120 + - name: Check running containers + run: | + echo "Checking running containers..." + docker ps -a + - name: Check Docusaurus logs + run: | + echo "Checking Docusaurus logs..." + docker logs docusaurus_local + - name: Check Docusaurus health + run: | + echo "Checking Docusaurus health..." + docker exec docusaurus_local curl -f http://localhost:3000 || exit 1 + - name: Verify build output run: | - cd docusaurus/ test -d build && echo "✅ Build successful" markdown-lint: From 03b00493cf0a66cdfa19945e32e3e6a9380f9217 Mon Sep 17 00:00:00 2001 From: Lucas Amaral Date: Mon, 19 May 2025 10:09:38 -0300 Subject: [PATCH 2/4] fix(ci): docker compose build script Signed-off-by: Lucas Amaral --- docusaurus/Dockerfile | 10 ++++++++++ docusaurus/docker-compose.yml | 1 - 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docusaurus/Dockerfile b/docusaurus/Dockerfile index 5c35d57..6a4f3be 100644 --- a/docusaurus/Dockerfile +++ b/docusaurus/Dockerfile @@ -22,6 +22,16 @@ RUN corepack enable WORKDIR /opt/docusaurus COPY package.json . COPY package-lock.json* . +COPY docs docs +COPY src src +COPY static static +COPY versioned_docs versioned_docs +COPY versioned_sidebars versioned_sidebars +COPY docusaurus.config.js . +COPY sidebars.js . +COPY sidebars.json . +COPY test.js . +COPY versions.json . #================================================================== # Local deployment diff --git a/docusaurus/docker-compose.yml b/docusaurus/docker-compose.yml index 66ed17c..90bc84d 100644 --- a/docusaurus/docker-compose.yml +++ b/docusaurus/docker-compose.yml @@ -10,7 +10,6 @@ services: ports: - "3000:3000" volumes: - - .:/opt/docusaurus - ./../readmes:/opt/docusaurus/docs environment: - NODE_ENV=development From c06f739d869b733f989aa26445fa65b2c10d1b21 Mon Sep 17 00:00:00 2001 From: Lucas Amaral Date: Mon, 19 May 2025 10:19:18 -0300 Subject: [PATCH 3/4] chore(ci): cleanup workflow file Signed-off-by: Lucas Amaral --- .github/workflows/docs-test.yml | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/.github/workflows/docs-test.yml b/.github/workflows/docs-test.yml index 8ca164e..926f5e7 100644 --- a/.github/workflows/docs-test.yml +++ b/.github/workflows/docs-test.yml @@ -17,14 +17,13 @@ name: Docs Check on: pull_request: - branches: [ main, 'test-*' ] + branches: [ main ] push: - branches: [ main, 'test-*' ] + branches: [ main ] jobs: docusaurus-test: name: Docusaurus Build & Log - # Replace by docker image (or docker compose) runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -32,16 +31,14 @@ jobs: run: | cd docusaurus/ docker compose -f docker-compose.yml build dev - # consider using caddy or serve - name: Start docusaurus container run: | cd docusaurus/ docker compose -f docker-compose.yml up -d dev - # consider using caddy or serve - name: Wait for docusaurus to start run: | echo "Waiting for Docusaurus to start..." - sleep 120 + sleep 60 - name: Check running containers run: | echo "Checking running containers..." @@ -53,11 +50,7 @@ jobs: - name: Check Docusaurus health run: | echo "Checking Docusaurus health..." - docker exec docusaurus_local curl -f http://localhost:3000 || exit 1 - - - name: Verify build output - run: | - test -d build && echo "✅ Build successful" + curl -f http://localhost:3000 > /dev/null || exit 1 markdown-lint: name: Markdown Format Check From 34778b57ba69544d1e536c4aae057bfac066aa43 Mon Sep 17 00:00:00 2001 From: Lucas Amaral Date: Mon, 19 May 2025 10:40:03 -0300 Subject: [PATCH 4/4] chore: reorganize dockerfile copy statements Signed-off-by: Lucas Amaral --- docusaurus/Dockerfile | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docusaurus/Dockerfile b/docusaurus/Dockerfile index 6a4f3be..3e32169 100644 --- a/docusaurus/Dockerfile +++ b/docusaurus/Dockerfile @@ -20,14 +20,19 @@ FROM node:22-slim AS base ENV FORCE_COLOR=0 RUN corepack enable WORKDIR /opt/docusaurus -COPY package.json . -COPY package-lock.json* . + +# Documentation contents +# The docs directory is overwritten by compose file COPY docs docs COPY src src COPY static static COPY versioned_docs versioned_docs COPY versioned_sidebars versioned_sidebars + +# Configuration files COPY docusaurus.config.js . +COPY package.json . +COPY package-lock.json* . COPY sidebars.js . COPY sidebars.json . COPY test.js .