Update CI workflow to trigger Pull Request CI only on code-level changes

[kokodak]

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 under api/docs and build/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 under build/charts are related to Helm charts.

However, changes in api/docs and build/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:

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• Chores
  • Updated CI workflow to ignore specific paths and file types during pull requests, improving efficiency.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

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.

Changes

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.

Assessment against linked issues

Objective	Addressed	Explanation
Run CI only on code-level change PR (#873)	✅

Poem

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1df48f5 and 56a78aa.

Files selected for processing (1)

• .github/workflows/ci.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• .github/workflows/ci.yml

[krapie]

Looks good to me considering including files vs excluding files for CI.
Could you please double-check this configuration? @hackerwins

[hackerwins]

Thanks for your contribution.