polish docs overview.md (#548) #274
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: docs | |
| on: | |
| pull_request: | |
| branches: [main] | |
| paths: | |
| - docs/** | |
| - ".github/workflows/docs.yml" | |
| push: | |
| branches: [main] | |
| paths: | |
| - docs/** | |
| - ".github/workflows/docs.yml" | |
| workflow_dispatch: | |
| permissions: | |
| contents: write | |
| jobs: | |
| test-deploy: | |
| if: github.event_name != 'push' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| cache: yarn | |
| cache-dependency-path: docs/yarn.lock | |
| - name: Install dependencies | |
| run: yarn --cwd docs install --frozen-lockfile | |
| - name: Test build website | |
| run: yarn --cwd docs build | |
| deploy-precheck: | |
| if: ${{ github.event_name != 'pull_request' }} | |
| runs-on: ubuntu-latest | |
| environment: docs-release | |
| outputs: | |
| gh-deploy-key: ${{ steps.gh-deploy-key.outputs.defined }} | |
| steps: | |
| - id: gh-deploy-key | |
| env: | |
| GH_PAGES_DEPLOY: ${{ secrets.GH_PAGES_DEPLOY }} | |
| if: "${{ env.GH_PAGES_DEPLOY != '' }}" | |
| run: echo "defined=true" >> $GITHUB_OUTPUT | |
| deploy: | |
| needs: [deploy-precheck] | |
| if: ${{ needs.deploy-precheck.outputs.gh-deploy-key == 'true' }} | |
| runs-on: ubuntu-latest | |
| environment: docs-release | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| cache: yarn | |
| cache-dependency-path: docs/yarn.lock | |
| - uses: webfactory/[email protected] | |
| with: | |
| ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }} | |
| - name: Deploy to GitHub Pages | |
| env: | |
| USE_SSH: true | |
| run: | | |
| export COCOINDEX_DOCS_POSTHOG_API_KEY=${{ vars.COCOINDEX_DOCS_POSTHOG_API_KEY }} | |
| export COCOINDEX_DOCS_MIXPANEL_API_KEY=${{ vars.COCOINDEX_DOCS_MIXPANEL_API_KEY }} | |
| export COCOINDEX_DOCS_ALGOLIA_APP_ID=${{ vars.COCOINDEX_DOCS_ALGOLIA_APP_ID }} | |
| export COCOINDEX_DOCS_ALGOLIA_API_KEY=${{ vars.COCOINDEX_DOCS_ALGOLIA_API_KEY }} | |
| git config --global user.email "${{ vars.COCOINDEX_DOCS_DEPLOY_USER_EMAIL }}" | |
| git config --global user.name "${{ vars.COCOINDEX_DOCS_DEPLOY_USER_NAME }}" | |
| yarn --cwd docs install --frozen-lockfile | |
| yarn --cwd docs deploy |