From 32d141156b188efccf7d840ef9fd043836369757 Mon Sep 17 00:00:00 2001 From: Vicente Russo Date: Mon, 1 Apr 2024 13:21:44 -0300 Subject: [PATCH] V4 docs (#33) * "vx.x" to be replaced in deployment * Deployment to github pages * Fix repo links --- .github/workflows/docs.yaml | 69 ++++++++++++++++++++++++----------- docs/docs/.vuepress/config.ts | 9 +++-- 2 files changed, 53 insertions(+), 25 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 42e12a8ab..097f09574 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,40 +1,67 @@ -name: Docs +name: Unified Deploy Docs on: push: branches: - main - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: "pages" - cancel-in-progress: true + - v3 jobs: - build_docs: - name: Build and deploy Docs + deploy: runs-on: ubuntu-latest environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} + permissions: + contents: write + id-token: write + pages: write steps: - - uses: actions/checkout@v3 - - name: Build - working-directory: docs + - name: Checkout v3 branch + uses: actions/checkout@v4 + with: + ref: "v3" + path: "v3" + + - name: Build v3 docs + run: | + cd v3/docs + sed -i'.bak' "s|base:.*|base: '/v3/',|" docs/.vuepress/config.ts + sed -i 's|text: "vx.x"|text: "v3.x"|' docs/.vuepress/config.ts + npm ci + npm run build + mv ./docs/.vuepress/dist ../../v3-docs + + - name: Checkout main branch + uses: actions/checkout@v4 + with: + ref: "main" + path: "main" + + - name: Build main docs run: | - npm install + cd main/docs + sed -i'.bak' "s|base:.*|base: '/',|" docs/.vuepress/config.ts + sed -i 's|text: "vx.x"|text: "v4.x"|' docs/.vuepress/config.ts + npm ci npm run build - touch docs/.vuepress/dist/.nojekyll + mv ./docs/.vuepress/dist ../../main-docs + + - name: Prepare deployment directory + run: | + mkdir deploy + mv main-docs/* deploy/ + mkdir deploy/v3 + mv v3-docs/* deploy/v3/ + - name: Setup Pages - uses: actions/configure-pages@v2 + uses: actions/configure-pages@v4 + - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v3 with: - path: docs/docs/.vuepress/dist + path: deploy + - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/docs/docs/.vuepress/config.ts b/docs/docs/.vuepress/config.ts index fdffb81a7..0493a518a 100644 --- a/docs/docs/.vuepress/config.ts +++ b/docs/docs/.vuepress/config.ts @@ -43,10 +43,11 @@ for (const locale of locales) { export default defineUserConfig({ locales: vueLocales, bundler: viteBundler({}), + base: '/', theme: defaultTheme({ logo: "/isar.svg", - repo: "isar/isar", - docsRepo: "isar/isar", + repo: "isar-community/isar", + docsRepo: "isar-community/isar", docsDir: "docs/docs", contributors: true, locales: themeLocales, @@ -64,11 +65,11 @@ export default defineUserConfig({ link: "https://t.me/isardb", }, { - text: "4.x", + text: "vx.x", children: [ { text: "v4.x", - link: "https://isar-community.dev/", + link: "https://isar-community.dev", }, { text: "v3.x",