[NA] [SDK] Refactor + Fix: Consistent Opik Optimizer Signatures #1039
Workflow file for this run
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 - Preview link | |
| on: | |
| pull_request: | |
| paths: | |
| - 'apps/opik-documentation/documentation/**' | |
| jobs: | |
| run: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| permissions: write-all | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Fern | |
| run: npm install -g [email protected] | |
| - name: Generate preview URL | |
| id: generate-docs | |
| working-directory: apps/opik-documentation/documentation | |
| 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 "URL=$URL" >> $GITHUB_OUTPUT | |
| echo "🌿 Preview your docs: $URL" > preview_url.txt | |
| - name: Check for broken links | |
| id: check-broken-links | |
| working-directory: apps/opik-documentation/documentation | |
| run: | | |
| echo -e "\n\n" >> preview_url.txt | |
| npx linkinator ${{ steps.generate-docs.outputs.URL }} \ | |
| --recurse \ | |
| --skip "search\/v2\/key" \ | |
| --skip "https://ai.google.dev/gemini-api" \ | |
| --skip "https://ai.google.dev/aistudio" \ | |
| --skip "chat.comet.com" \ | |
| --skip "http://localhost" \ | |
| --skip "http://localhost:5173" \ | |
| --skip "googletagmanager.com" \ | |
| --skip "insights/script.js" \ | |
| --format csv | awk -F',' ' | |
| BEGIN { found_broken = 0 } | |
| NR==1 {next} | |
| { | |
| # Remove leading/trailing quotes from each field | |
| gsub(/^"|"$/, "", $1) | |
| gsub(/^"|"$/, "", $2) | |
| gsub(/^"|"$/, "", $4) | |
| if ($3 != "OK" && $2 != "403") { | |
| if (found_broken == 0) { | |
| print "**The following broken links where found:**\n\n" >> "preview_url.txt" | |
| found_broken = 1 | |
| } | |
| printf "Page: %s\n❌ Broken link: %s (%s)\n\n", $4, $1, $2 >> "preview_url.txt" | |
| } | |
| } | |
| END { | |
| if (found_broken == 0) { | |
| print "No broken links found" >> "preview_url.txt" | |
| } | |
| } | |
| ' | |
| - name: Comment URL in PR | |
| uses: thollander/[email protected] | |
| with: | |
| filePath: apps/opik-documentation/documentation/preview_url.txt |