(docs) Add Building Your Docs section #465
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: preview-docs | |
| on: | |
| pull_request: | |
| paths: | |
| - "fern/**" | |
| - "fern/apis/public-api/**" | |
| - "fern/docs.yml" | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| inputs: | |
| prNumber: | |
| description: "Pull Request Number" | |
| required: true | |
| default: "" | |
| jobs: | |
| run: | |
| runs-on: ubuntu-latest | |
| permissions: write-all | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Fern | |
| run: npm install -g fern-api | |
| - name: Generate preview URL | |
| id: generate-docs | |
| env: | |
| FERN_TOKEN: ${{ secrets.FERN_TOKEN }} | |
| run: | | |
| OUTPUT=$(fern generate --docs --preview 2>&1) || true | |
| echo "$OUTPUT" | |
| URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()') | |
| echo "Preview URL: $URL" | |
| echo "🌿 Preview your docs: $URL" > preview_url.txt | |
| - name: Comment URL in PR | |
| uses: thollander/[email protected] | |
| with: | |
| filePath: preview_url.txt |