From 9e8880c49cc9d7a6c281e6341cd387d1843f1789 Mon Sep 17 00:00:00 2001 From: Severino Date: Tue, 1 Oct 2024 18:00:39 +0200 Subject: [PATCH] trying docs workflow again --- .github/workflows/deploy-docs.yml | 62 ++++++++++++++++--------------- 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index a2870ed..d75e2e9 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,47 +1,51 @@ - -name: Deploy Docs +name: docs on: + # trigger deployment on every push to main branch push: - branches: - # make sure this is the branch you are using - - main - -permissions: - contents: write + branches: [main] + # trigger deployment manually + workflow_dispatch: jobs: - deploy-gh-pages: + docs: runs-on: ubuntu-latest + steps: - - name: Checkout - uses: actions/checkout@v4 + - uses: actions/checkout@v4 with: + # fetch all commits to get last updated time or other git log info fetch-depth: 0 - # if your docs needs submodules, uncomment the following line - # submodules: true - + - name: Setup pnpm + uses: pnpm/action-setup@v2 + with: + # choose pnpm version to use + version: 8 + # install deps with pnpm + run_install: true - name: Setup Node.js uses: actions/setup-node@v4 with: + # choose node.js version to use node-version: 20 - cache: npm - - - name: Install Deps - run: npm ci + # cache deps for pnpm + cache: pnpm - - name: Build Docs - env: - NODE_OPTIONS: --max_old_space_size=8192 - run: |- - npm run docs:build - > docs/.vuepress/dist/.nojekyll + # run build script + - name: Build VuePress site + run: pnpm docs:build - - name: Deploy Docs - uses: JamesIves/github-pages-deploy-action@v4 + # please check out the docs of the workflow for more details + # @see https://github.com/crazy-max/ghaction-github-pages + - name: Deploy to GitHub Pages + uses: crazy-max/ghaction-github-pages@v4 with: - # This is the branch where the docs are deployed to - branch: gh-pages - folder: docs/.vuepress/dist + # deploy to gh-pages branch + target_branch: gh-pages + # deploy the default output dir of VuePress + build_dir: docs/.vuepress/dist + env: + # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file