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

[improve] add ci for home #2024

Merged
merged 2 commits into from
May 22, 2024
Merged

Conversation

LiuTianyou
Copy link
Contributor

@LiuTianyou LiuTianyou commented May 21, 2024

What's changed?

  1. add ci for home ([Task] When the document is modified, add CI to verify whether the modification can pass the build #2020)

Checklist

  • I have read the Contributing Guide
  • I have written the necessary doc or comment.
  • I have added the necessary unit tests and all cases have passed.

Add or update API

  • I have added the necessary e2e tests and all cases have passed.

@github-actions github-actions bot added the infra label May 21, 2024
# specific language governing permissions and limitations
# under the License.

name: DOC CI
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we include the link check ci in the check md file along with.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea. When executing npm run build, it will verify whether the file referenced in sidebar.json exists. Indeed, the link in the .md file has not yet been verified. Let me try to see if it is easy to implement.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@yuluo-yx I'm really sorry, I made a mistake before. According to the configuration in docusaurus.config.js, if a dead link occurs, the build process will be terminated, and the purpose of link verification can be achieved.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',

Copy link
Contributor

Choose a reason for hiding this comment

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

got it.

@tomsun28
Copy link
Contributor

yes, npm run build can verify doc link.

Copy link
Contributor

@tomsun28 tomsun28 left a comment

Choose a reason for hiding this comment

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

LGTM

@tomsun28 tomsun28 added the good first pull request Good for newcomers label May 22, 2024
@tomsun28 tomsun28 merged commit 34b9581 into apache:master May 22, 2024
3 checks passed
@LiuTianyou LiuTianyou deleted the improve-ci-home branch May 27, 2024 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

3 participants