Skip to content

Docs: Update deps and remove vulnerable package until it gets fixed #57

Docs: Update deps and remove vulnerable package until it gets fixed

Docs: Update deps and remove vulnerable package until it gets fixed #57

Workflow file for this run

name: Deploy docs to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: [main]
paths:
- docs/**
- plugin/src/main/kotlin/**
- release/version.txt
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
env:
BUILD_PATH: docs
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
- name: Setup Java
uses: actions/setup-java@v5
with:
distribution: temurin
java-version-file: .tool-versions
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4
with:
cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
- name: Setup Node
uses: actions/setup-node@v5
with:
node-version-file: .tool-versions
cache: 'npm'
cache-dependency-path: docs/package-lock.json
- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Install dependencies
run: npm ci
working-directory: ${{ env.BUILD_PATH }}
- name: Check for formatting or typing errors
run: npm run check
working-directory: ${{ env.BUILD_PATH }}
- name: Build API Docs
run: ./gradlew javadoc
- name: Build with Astro
run: |
npm run build -- \
--site "${{ steps.pages.outputs.origin }}" \
--base "${{ steps.pages.outputs.base_path }}"
working-directory: ${{ env.BUILD_PATH }}
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
path: ${{ env.BUILD_PATH }}/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
name: Deploy
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4