Update the swagger json github workflow #359
Open
Conversation
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
Contributor
📝 WalkthroughWalkthroughCI workflow for generating and publishing Swagger JSON updated: Maven runs in batch mode, Swagger fetch now validates JSON and requires non-empty paths, polling increased, API shutdown/port cleanup hardened, checkout fetches full history, PR action/version/branch/title/commit conventions changed, and created PRs delete the branch. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
drtechie
reviewed
Feb 11, 2026
.github/workflows/swagger-json.yml
Outdated
| run: | | ||
| mkdir -p amrit-docs/docs/swagger | ||
| cp common-api.json amrit-docs/docs/swagger/common-api.json | ||
| cp tm-api.json amrit-docs/docs/swagger/tm-api.json |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.github/workflows/swagger-json.yml:
- Around line 96-104: The workflow currently generates unique branches per run
via the create-pull-request step (uses: peter-evans/create-pull-request@v8)
using branch: auto/swagger-update-${{ github.run_id }}-${{ github.run_attempt
}}, which causes many stale PRs; change this to a fixed branch name (e.g.,
branch: auto/swagger-update) so the action will update/force-push the same
branch and keep a single PR open, retaining delete-branch: true for cleanup
after merge.
🧹 Nitpick comments (2)
.github/workflows/swagger-json.yml (2)
67-80: Misleading comments and unconditionalsleep 5before the PID check.Two concerns:
Comment–code mismatch: The "Graceful shutdown" comment (Line 70) annotates the bare
sleep 5, while the actual graceful signal (SIGTERM, Line 75) sits under the "Force kill" comment (Line 72). This will confuse future maintainers.Process-group kill may be a no-op:
kill -- -"$PID"treats$PIDas a PGID. The$!captured on Line 36 is the Maven wrapper PID, which is not guaranteed to be a process-group leader in the Actions runner shell. If it isn't, bothkillcalls silently fail and onlyfuseron Line 80 actually cleans up — so the logic is safe, but the intermediate steps would be dead code.Minor: The unconditional
sleep 5(Line 71) runs even whenapi_pid.txtdoesn't exist. Move it inside theifblock.Proposed cleanup
- name: Stop API if: always() run: | - # Graceful shutdown of the process group - sleep 5 - # Force kill the process group if still running if [ -f api_pid.txt ]; then - PID=$(cat api_pid.txt) - kill -TERM -- -"$PID" 2>/dev/null || true - sleep 2 - kill -9 -- -"$PID" 2>/dev/null || true - fi - # Fallback: kill any remaining java process on port 9090 - fuser -k 9090/tcp 2>/dev/null || true + PID=$(cat api_pid.txt) + # Graceful SIGTERM, then wait + kill -TERM "$PID" 2>/dev/null || true + sleep 5 + # Force SIGKILL if still running + kill -9 "$PID" 2>/dev/null || true + sleep 1 + fi + # Fallback: kill anything still on port 9090 + fuser -k 9090/tcp 2>/dev/null || true
30-36: Consider usingsetsidto guarantee a new process group for reliable group-kill in the Stop step.The PID captured by
$!on Line 36 may not be a process-group leader (relevant to thekill -- -"$PID"calls in the Stop step). If you want the process-group kill pattern to work reliably, launch withsetsid:- mvn spring-boot:run \ + setsid mvn spring-boot:run \ -Dspring-boot.run.profiles=swagger \ -Dspring-boot.run.arguments=--server.port=9090 \ > app.log 2>&1 &This ensures the Maven process is a session/group leader, making
kill -- -"$PID"effective and cleaning up all child processes (including the forked Java process).
|
Contributor
✅ Actions performedFull review triggered. |
Contributor
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Bug Fixes
Chores
Documentation