name: Format + Docs Workflow on: push: paths: ["docs/**", "**.md", "**.toml", "**.js", "**.json", "**.ts"] pull_request: paths: ["docs/**", "**.md", "**.toml", "**.js", "**.json", "**.ts"] jobs: # Run the dprint code formatter for documentation dprint: name: Dprint [Docs Formatter] runs-on: ubuntu-latest steps: - name: Setup | Checkout uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Docs | Format uses: dprint/check@9cb3a2b17a8e606d37aae341e49df3654933fc23 # v2.3 # Validate preset files taplo: name: Taplo [Preset schema validation] runs-on: ubuntu-latest steps: - name: Setup | Checkout uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Install | Taplo uses: taiki-e/install-action@7a79fe8c3a13344501c80d99cae481c1c9085912 # v2.81.10 with: tool: taplo-cli@0.10.0 - name: Presets | Validate with schema run: taplo lint --schema "file://${GITHUB_WORKSPACE}/.github/config-schema.json" docs/public/presets/toml/*.toml # If this is not a Crowdin PR, block changes to translated documentation block-crowdin: name: Block Translated Changes runs-on: ubuntu-latest if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref != 'i18n_master' }} steps: - name: Setup | Checkout uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: fetch-depth: 0 - name: Prevent File Change uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0 with: script: | const { execSync } = require('child_process'); const pattern = /^docs\/[a-z][a-z][a-z]?-[A-Z][A-Z]?\/.*$/; const base = context.payload.pull_request.base.sha; const head = context.payload.pull_request.head.sha; const result = execSync(`git diff --name-only ${base} ${head}`).toString().split('\n'); for (const file of result) { if (pattern.test(file)) { core.setFailed(`To avoid conflicts, changes to the translated documentation are only allowed via Crowdin at https://translate.starship.rs.`); break; } } # Vitepress build vitepress: name: Vitepress [Build] runs-on: ubuntu-latest steps: - name: Setup | Checkout uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 - name: Setup | Node uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0 with: node-version: 24.16.0 cache: 'npm' cache-dependency-path: docs/package-lock.json - name: Setup | Install dependencies run: npm install working-directory: docs - name: Build | Build docs site run: npm run build working-directory: docs