Cypress Docs (#3487) #329
This file contains 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 | |
| on: | |
| push: | |
| branches: | |
| - main | |
| paths: | |
| - "api/*" | |
| - "cli/cmd/*" | |
| - "docs/**" | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| publish: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - name: Check out repo | |
| uses: actions/checkout@v2 | |
| # Go is required to generate cli docs | |
| - name: Setup go | |
| uses: actions/setup-go@v3 | |
| with: | |
| go-version-file: 'go.mod' | |
| cache: true | |
| cache-dependency-path: go.mod | |
| # Node is required for npm | |
| - name: Set up Node | |
| uses: actions/setup-node@v2 | |
| with: | |
| node-version: "18" | |
| # build CLI docs | |
| - name: Generate tracetest CLI reference docs | |
| run: | | |
| cd cli | |
| make docgen | |
| # Install and build Docusaurus website | |
| - name: Build Docusaurus website | |
| run: | | |
| cd docs | |
| npm install | |
| npm run build | |
| # Install and build Docusaurus website | |
| - name: Build Docusaurus website | |
| run: | | |
| cd docs | |
| npm install | |
| npm run build | |
| - name: Deploy to GitHub Pages | |
| if: success() | |
| uses: crazy-max/ghaction-github-pages@v2 | |
| with: | |
| target_branch: gh-pages | |
| build_dir: docs/build | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |