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

chore: fix not-correct lint #5356

Merged
merged 1 commit into from
Mar 3, 2025

Conversation

spaceluke
Copy link
Member

@spaceluke spaceluke commented Mar 2, 2025

What's the purpose of this PR

Fix not correct lint for openapi shell scripts

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Read the Contributing Guide before making this pull request.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit tests to verify the code.
  • Run mvn clean test to make sure this pull request doesn't break anything.
  • Update the CHANGES log.

Summary by CodeRabbit

  • Documentation
    • Updated both English and Chinese documentation to direct users to the correct folder for accessing Apollo Open API shell scripts, ensuring the links now point to the appropriate directory.

@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Mar 2, 2025
Copy link
Contributor

coderabbitai bot commented Mar 2, 2025

Walkthrough

The documentation for the Apollo Open API Platform has been updated in both the English and Chinese versions. The URL reference directing users to the location of shell scripts has been corrected from the scripts/sql folder to the scripts/openapi/bash folder, ensuring users are pointed to the appropriate directory.

Changes

File(s) Change Summary
docs/en/.../apollo-open-api-platform.md
docs/zh/.../apollo-open-api-platform.md
Updated URL for shell scripts: changed folder reference from scripts/sql to scripts/openapi/bash in both the English and Chinese documents.

Suggested labels

lgtm

Suggested reviewers

  • nobodyiam

Poem

In a garden of docs under the moonlight,
I hopped to update and make things right.
Paths aligned like stars in the night,
With a twitch of my nose and a joyful delight.
Code and clarity shine ever so bright!
🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
docs/zh/portal/apollo-open-api-platform.md (1)

74-74: Markdown Link Formatting Suggestion

To improve readability and comply with markdownlint (MD034), consider wrapping the bare URL in markdown link syntax. For example, you might update the line to:
* 全部和openapi有关的shell脚本在文件夹 [scripts/openapi/bash](https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash) 下

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

74-74: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5eb320f and 847920f.

📒 Files selected for processing (2)
  • docs/en/portal/apollo-open-api-platform.md (1 hunks)
  • docs/zh/portal/apollo-open-api-platform.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/en/portal/apollo-open-api-platform.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/zh/portal/apollo-open-api-platform.md

74-74: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)
🔇 Additional comments (1)
docs/zh/portal/apollo-open-api-platform.md (1)

74-74: Updated Shell Script Directory URL Confirmed

The URL has been updated to point to the correct folder (scripts/openapi/bash) for all OpenAPI-related shell scripts. This change clearly aligns with the PR objective and ensures users are directed to the appropriate location.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

74-74: Bare URL used
null

(MD034, no-bare-urls)

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 2, 2025
@nobodyiam nobodyiam force-pushed the minor/openapi-docs-lint branch from 847920f to 0bb871d Compare March 3, 2025 01:05
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
docs/en/portal/apollo-open-api-platform.md (1)

79-79: Update URL Reference and Improve Markdown URL Formatting
The URL now correctly points to the OpenAPI bash scripts folder. To further comply with lint rules (MD034: no-bare-urls), consider wrapping the URL in markdown link syntax so that it isn’t flagged as a bare URL.
[static_analysis]

-* All the shell scripts related to openapi are in the folder https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash
+* All the shell scripts related to openapi are in the folder [https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash](https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

79-79: Bare URL used
null

(MD034, no-bare-urls)

docs/zh/portal/apollo-open-api-platform.md (1)

74-74: 更新脚本目录 URL 并优化 Markdown 格式
当前更新后的 URL 正确指向了 OpenAPI 相关的 shell 脚本所在文件夹。建议将裸露的 URL 转换为 Markdown 格式的链接,以符合 lint 规范(MD034: no-bare-urls),从而提高文档的统一性和可读性。
[static_analysis]

-* 全部和openapi有关的shell脚本在文件夹 https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash 下
+* 全部和openapi有关的shell脚本在文件夹 [https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash](https://github.com/apolloconfig/apollo/tree/master/scripts/openapi/bash) 下
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

74-74: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 847920f and 0bb871d.

📒 Files selected for processing (2)
  • docs/en/portal/apollo-open-api-platform.md (1 hunks)
  • docs/zh/portal/apollo-open-api-platform.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/en/portal/apollo-open-api-platform.md

79-79: Bare URL used
null

(MD034, no-bare-urls)

docs/zh/portal/apollo-open-api-platform.md

74-74: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (8)

@nobodyiam nobodyiam merged commit 09e02fb into apolloconfig:master Mar 3, 2025
8 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants