|
| 1 | +name: Sync Swagger to AMRIT-Docs |
| 2 | + |
| 3 | +on: |
| 4 | + push: |
| 5 | + branches: [ main ] |
| 6 | + workflow_dispatch: |
| 7 | + |
| 8 | +jobs: |
| 9 | + swagger-sync: |
| 10 | + runs-on: ubuntu-latest |
| 11 | + timeout-minutes: 20 |
| 12 | + |
| 13 | + steps: |
| 14 | + - name: Checkout API repo |
| 15 | + uses: actions/checkout@v4 |
| 16 | + |
| 17 | + - name: Set up Java 17 |
| 18 | + uses: actions/setup-java@v4 |
| 19 | + with: |
| 20 | + distribution: temurin |
| 21 | + java-version: 17 |
| 22 | + cache: maven |
| 23 | + |
| 24 | + - name: Build API (skip tests) |
| 25 | + run: mvn -B clean package -DskipTests |
| 26 | + |
| 27 | + - name: Install jq |
| 28 | + run: sudo apt-get update && sudo apt-get install -y jq |
| 29 | + |
| 30 | + - name: Run API in swagger profile |
| 31 | + run: | |
| 32 | + mvn spring-boot:run \ |
| 33 | + -Dspring-boot.run.profiles=swagger \ |
| 34 | + -Dspring-boot.run.arguments=--server.port=9090 \ |
| 35 | + > app.log 2>&1 & |
| 36 | + echo $! > api_pid.txt |
| 37 | +
|
| 38 | + - name: Wait for API & fetch Swagger |
| 39 | + run: | |
| 40 | + for i in {1..40}; do |
| 41 | + CODE=$(curl --connect-timeout 2 --max-time 5 -s -o swagger_raw.json -w "%{http_code}" http://localhost:9090/v3/api-docs || true) |
| 42 | +
|
| 43 | + if [ "$CODE" = "200" ]; then |
| 44 | + jq . swagger_raw.json > common-api.json || { |
| 45 | + echo "Swagger JSON invalid" |
| 46 | + cat swagger_raw.json |
| 47 | + exit 1 |
| 48 | + } |
| 49 | +
|
| 50 | + if [ "$(jq '.paths | length' common-api.json)" -eq 0 ]; then |
| 51 | + echo "Swagger paths empty – failing" |
| 52 | + exit 1 |
| 53 | + fi |
| 54 | +
|
| 55 | + echo "Swagger generated successfully" |
| 56 | + exit 0 |
| 57 | + fi |
| 58 | +
|
| 59 | + echo "Waiting for API... ($i)" |
| 60 | + sleep 4 |
| 61 | + done |
| 62 | +
|
| 63 | + echo "Swagger not generated" |
| 64 | + cat app.log || true |
| 65 | + exit 1 |
| 66 | +
|
| 67 | + - name: Stop API |
| 68 | + if: always() |
| 69 | + run: | |
| 70 | + # Graceful shutdown of the process group |
| 71 | + sleep 5 |
| 72 | + # Force kill the process group if still running |
| 73 | + if [ -f api_pid.txt ]; then |
| 74 | + PID=$(cat api_pid.txt) |
| 75 | + kill -TERM -- -"$PID" 2>/dev/null || true |
| 76 | + sleep 2 |
| 77 | + kill -9 -- -"$PID" 2>/dev/null || true |
| 78 | + fi |
| 79 | + # Fallback: kill any remaining java process on port 9090 |
| 80 | + fuser -k 9090/tcp 2>/dev/null || true |
| 81 | +
|
| 82 | + - name: Checkout AMRIT-Docs |
| 83 | + uses: actions/checkout@v4 |
| 84 | + with: |
| 85 | + repository: PSMRI/AMRIT-Docs |
| 86 | + token: ${{ secrets.DOCS_REPO_TOKEN }} |
| 87 | + path: amrit-docs |
| 88 | + fetch-depth: 0 |
| 89 | + |
| 90 | + - name: Copy Swagger JSON |
| 91 | + run: | |
| 92 | + mkdir -p amrit-docs/docs/swagger |
| 93 | + cp common-api.json amrit-docs/docs/swagger/common-api.json |
| 94 | +
|
| 95 | + # Use a fixed branch name for PRs to avoid accumulating stale PRs. |
| 96 | + # This ensures only one open PR is updated per run; delete-branch: true cleans up after merge. |
| 97 | + - name: Create Pull Request |
| 98 | + uses: peter-evans/create-pull-request@v8 |
| 99 | + with: |
| 100 | + token: ${{ secrets.DOCS_REPO_TOKEN }} |
| 101 | + path: amrit-docs |
| 102 | + branch: auto/swagger-update-common-api |
| 103 | + base: main |
| 104 | + commit-message: "chore(docs): auto-update Common-API swagger" |
| 105 | + title: "chore(docs): auto-update Common-API swagger" |
| 106 | + delete-branch: true |
| 107 | + body: | |
| 108 | + This PR automatically updates Common-API Swagger JSON |
| 109 | + from the latest main branch build. |
0 commit comments