Sync the Docs #14
Workflow file for this run
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: Sync the Docs | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| version: | |
| description: Pants Version to use (should be the full version, like "2.20.1rc2") | |
| required: true | |
| type: string | |
| pants_repo_ref: | |
| required: true | |
| type: string | |
| jobs: | |
| sync: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Generate `help-all.json` | |
| - name: Pants on! | |
| run: | | |
| curl --proto '=https' --tlsv1.2 -fsSL https://static.pantsbuild.org/setup/get-pants.sh | bash | |
| echo "$HOME/.local/bin" >> $GITHUB_PATH | |
| - name: Generate help JSON | |
| # Run the command twice, since the first run might put extraneous crap on stdout | |
| run: | | |
| touch pants.toml | |
| PANTS_VERSION="${{ inputs.version }}" pants help-all > /dev/null | |
| PANTS_VERSION="${{ inputs.version }}" pants help-all > help-all.json | |
| # Checkout both repos | |
| - name: Checkout pants repo | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: pantsbuild/pants | |
| ref: ${{ inputs.pants_repo_ref }} | |
| fetch-depth: 0 | |
| path: pants | |
| - name: Checkout docs repo | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: pantsbuild/pantsbuild.org | |
| fetch-depth: 0 | |
| path: pantsbuild.org | |
| # Calculate destination | |
| - name: Calculate branch name | |
| id: get-branch-name | |
| run: echo "BRANCH_NAME=$(echo "${{ inputs.version }}" | sed -E 's/^([0-9]+)\.([0-9]+)\.\w+.*/\1.\2.x/')" >> "${GITHUB_OUTPUT}" | |
| - name: Calculate destination | |
| id: get-destination-dir | |
| run: | | |
| DESTINATION_DIR="versioned_docs/version-${{ steps.get-branch-name.outputs.BRANCH_NAME }}" | |
| if [ ! -d "pantsbuild.org/$DESTINATION_DIR" ]; then | |
| DESTINATION_DIR="docs" | |
| fi | |
| echo "DESTINATION_DIR=$(echo "$DESTINATION_DIR")" >> "${GITHUB_OUTPUT}" | |
| # Generate reference docs | |
| - name: Setup Node | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: "18" | |
| - name: Get yarn cache | |
| id: yarn-cache | |
| run: echo "YARN_CACHE_DIR=$(yarn cache dir)" >> "${GITHUB_OUTPUT}" | |
| - name: Cache dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ steps.yarn-cache.outputs.YARN_CACHE_DIR }} | |
| key: ${{ runner.os }}-website-${{ hashFiles('pantsbuild.org/**/yarn.lock') }} | |
| restore-keys: | | |
| ${{ runner.os }}-website- | |
| - run: yarn install --frozen-lockfile | |
| working-directory: pantsbuild.org | |
| - name: Generate reference docs | |
| run: npm run generate-templates "${{ steps.get-destination-dir.outputs.DESTINATION_DIR }}" ../help-all.json | |
| working-directory: pantsbuild.org | |
| # Sync the docs repo | |
| - name: Replace docs | |
| run: | | |
| rm -rf "pantsbuild.org/${{ steps.get-destination-dir.outputs.DESTINATION_DIR }}" | |
| cp -r pants/docs "pantsbuild.org/${{ steps.get-destination-dir.outputs.DESTINATION_DIR }}" | |
| # Commit and create a PR | |
| - name: Commit changes | |
| run: | | |
| git config --local user.email "[email protected]" | |
| git config --local user.name "Worker Pants (Pantsbuild GitHub Automation Bot)" | |
| git checkout -b "automation/sync-${{ inputs.version }}" | |
| git add -A | |
| git commit -m "Update docs site for version ${{ inputs.version }}" -a | |
| git push -u origin "automation/sync-${{ inputs.version }}" | |
| working-directory: pantsbuild.org | |
| - name: Make a PR | |
| run: gh pr create --title "Update docs site for version ${{ inputs.version }}" --body "" --base prerelease | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| working-directory: pantsbuild.org |