docs: Document custom CloudStorage for local disk and NAS (#783) #598
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docusaurus deploy | |
| on: | |
| push: | |
| branches: | |
| - main | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy: | |
| if: github.repository == 'serverpod/serverpod_docs' | |
| runs-on: ubuntu-latest | |
| environment: deploy | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| path: src | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: npm | |
| cache-dependency-path: src/package-lock.json | |
| - name: Build docs | |
| run: | | |
| cd src | |
| npm ci | |
| npm run test:open-graph | |
| npm run build | |
| - name: Verify markdown export | |
| run: | | |
| cd src | |
| node util/verify_markdown_export.js | |
| - name: Verify Open Graph images | |
| run: | | |
| cd src | |
| node util/verify_open_graph_images.js | |
| - uses: actions/checkout@v4 | |
| with: | |
| path: target | |
| ref: main | |
| repository: serverpod/serverpod.github.io | |
| ssh-key: ${{ secrets.GH_PAGES_DEPLOY }} | |
| - name: Deploy to target | |
| run: | | |
| git config --global user.email "serverpod_docs@serverpod.dev" | |
| git config --global user.name "serverpod_docs" | |
| # Dotfiles must deploy too (.nojekyll keeps GitHub Pages from | |
| # running Jekyll over the generated .md files), so copy the | |
| # directory contents rather than a dotfile-skipping glob. | |
| rm -rf target/docs | |
| mkdir -p target/docs | |
| cp target/CNAME target/docs | |
| cp -a src/build/. target/docs | |
| cd target | |
| git add . | |
| if git diff --cached --quiet; then | |
| echo "No changes to deploy — skipping commit and push." | |
| exit 0 | |
| fi | |
| git commit -m "Deployed by Serverpod docs deploy action" | |
| git push | |