feat: add changed markdown pages to preview PR comment #154
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: preview-docs | |
| on: pull_request | |
| jobs: | |
| run: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install Fern CLI tool | |
| 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" >> $GITHUB_OUTPUT | |
| echo "Preview URL: $URL" | |
| - name: Get page links for changed MDX files | |
| id: page-links | |
| env: | |
| FERN_TOKEN: ${{ secrets.FERN_TOKEN }} | |
| run: | | |
| PREVIEW_URL="${{ steps.generate-docs.outputs.preview_url }}" | |
| CHANGED_FILES=$(git diff --name-only origin/main...HEAD -- '*.mdx' 2>/dev/null || echo "") | |
| if [ -z "$CHANGED_FILES" ] || [ -z "$PREVIEW_URL" ]; then | |
| echo "page_links=" >> $GITHUB_OUTPUT; exit 0 | |
| fi | |
| BASE_URL=$(echo "$PREVIEW_URL" | grep -oP 'https?://[^/]+') | |
| FILES_PARAM=$(echo "$CHANGED_FILES" | tr '\n' ',' | sed 's/,$//') | |
| RESPONSE=$(curl -sf -H "FERN_TOKEN: $FERN_TOKEN" "${PREVIEW_URL}/api/fern-docs/get-slug-for-file?files=${FILES_PARAM}" 2>/dev/null) || { | |
| echo "page_links=" >> $GITHUB_OUTPUT; exit 0 | |
| } | |
| PAGE_LINKS=$(echo "$RESPONSE" | jq -r --arg url "$BASE_URL" \ | |
| '.mappings[] | select(.slug != null) | "- [\(.slug)](\($url)/\(.slug))"') | |
| if [ -n "$PAGE_LINKS" ]; then | |
| { echo "page_links<<EOF"; echo "$PAGE_LINKS"; echo "EOF"; } >> $GITHUB_OUTPUT | |
| else | |
| echo "page_links=" >> $GITHUB_OUTPUT | |
| fi | |
| - name: Create comment content | |
| run: | | |
| echo ":herb: **Preview your docs:** <${{ steps.generate-docs.outputs.preview_url }}>" > comment.md | |
| if [ -n "${{ steps.page-links.outputs.page_links }}" ]; then | |
| echo "" >> comment.md | |
| echo "Here are the markdown pages you've updated:" >> comment.md | |
| echo "${{ steps.page-links.outputs.page_links }}" >> comment.md | |
| fi | |
| - name: Comment URL in PR | |
| uses: thollander/actions-comment-pull-request@v2.4.3 | |
| with: | |
| filePath: comment.md | |
| comment_tag: preview-docs | |
| mode: upsert |