Closed kokodak closed 3 weeks ago
The recent change in the .github/workflows/ci.yml
file is aimed at optimizing the CI process. Specifically, the CI workflow is now configured to ignore pull requests that only involve modifications within api/docs/
, build/charts/
, markdown files, text files, or .gitignore
. This ensures that CI runs are only triggered for code-level changes, improving efficiency.
Files | Change Summary |
---|---|
.github/workflows/ci.yml |
Added paths to be ignored for pull requests, excluding files in api/docs/ , build/charts/ , markdown files, text files, and .gitignore . |
Objective | Addressed | Explanation |
---|---|---|
Run CI only on code-level change PR (#873) | ✅ |
Amid the lines of code, we prance, Ignoring docs, a clever dance. Charts and texts, we skip with glee, For CI now runs more efficiently. Hoppity hop, the code's our play, In the bright GitHub meadow, we stay! 🌸🐇
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
What this PR does / why we need it:
This PR adjusts so that changes in documentation files like
.md
and.txt
, as well as those underapi/docs
andbuild/charts
directories, no longer trigger PR events.The current CI workflow primarily uses Docker Compose to set up a local development environment for building, testing, linting, benchmarking, and shard testing the Go project.
Changes under
api/docs
appear to be documented in swagger via the openapi spec, and underbuild/charts
are related to Helm charts.However, changes in
api/docs
andbuild/charts
seem unrelated to the current CI process and are likely handled during deployment instead. Therefore, I adjust not to trigger CI on PR events.Which issue(s) this PR fixes:
Fixes #873
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
Additional documentation:
Checklist:
Summary by CodeRabbit