Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readme for build status #1315

Merged
merged 2 commits into from
May 6, 2024
Merged

Conversation

CrazyHZM
Copy link
Contributor

@CrazyHZM CrazyHZM commented Apr 29, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the build badge URL in the README to reflect the latest workflow path.
    • Updated the build badge URL in the README_ZH.md file for SOFABoot from a GitHub Actions workflow badge to a Maven badge.

Signed-off-by: crazyhzm <crazyhzm@apache.org>
@sofastack-cla sofastack-cla bot added bug Something isn't working cla:yes size/XS labels Apr 29, 2024
Copy link

coderabbitai bot commented Apr 29, 2024

Walkthrough

The modification involves updating the build badge URLs in both the README.md and README_ZH.md files for SOFABoot. The changes switch the badges from GitHub Actions workflow to Maven badges, enhancing clarity and consistency across the project documentation.

Changes

File Change Summary
README.md Updated build badge URL to point to the Maven workflow
README_ZH.md Updated build badge URL to point to Maven instead of GitHub Actions workflow

🐇✨
Amidst the code's gentle hum,
SOFABoot's badge now sings a new sum.
From GitHub's embrace to Maven's glow,
A change embraced, a clearer show.
Let's dance in lines of code so fine,
SOFABoot shines, a badge divine! 🎉
🐇✨


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 8b34b3a and 02a9855.
Files selected for processing (1)
  • README_ZH.md (1 hunks)
Additional Context Used
LanguageTool (2)
README_ZH.md (2)

Near line 16: 成分累赘: “来自” “于” 不一起使用,请删除 “于”:"来自"。
Context: ...微服务应用启动的时候,必须要先保证启动后应用是健康的,才可以将上游的流量放进来(来自于 RPC,网关,定时任务等等流量),否则就可能会导致一定时间内大量的错误发生。 ...


Near line 61: 您的意思是""的""吗?
Context: ...五、感谢 SOFA 的第一个版本是阿玺创造的,感谢阿玺给 SOFA 打下了坚实地基础,也非常感谢在 SOFA 的历史中给 SOFA 贡献过代码的人们。 ## ...

Additional comments not posted (1)
README_ZH.md (1)

3-3: Updated build status badge URL to point directly to the maven.yml workflow. This change accurately reflects the Maven build status.


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
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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

codecov bot commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.15%. Comparing base (9e2b142) to head (02a9855).

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #1315      +/-   ##
============================================
+ Coverage     83.07%   83.15%   +0.08%     
- Complexity     2959     2961       +2     
============================================
  Files           337      337              
  Lines          9707     9707              
  Branches       1168     1168              
============================================
+ Hits           8064     8072       +8     
+ Misses         1132     1127       -5     
+ Partials        511      508       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Jermaine Hua <crazyhzm@apache.org>
Copy link
Contributor

@HzjNeverStop HzjNeverStop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HzjNeverStop HzjNeverStop merged commit 0563f31 into sofastack:master May 6, 2024
7 checks passed
@CrazyHZM CrazyHZM deleted the fix/readme branch May 7, 2024 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working cla:yes size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants