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

add a circleci integration: check unclosed tags (#3786) #3809

Merged
merged 6 commits into from
Sep 3, 2020

Conversation

ti-srebot
Copy link
Contributor

cherry-pick #3786 to release-4.0


What is changed, added or deleted? (Required)

After we migrate to the new website implementation, unclosed HTML tags will cause a build failure. If we just rely on people to review and find all unclosed tags from possibly large changes, it is not realistic at all.

So I wrote a python script as a new circleci integration, which detects the unclosed tags from all changed files in a PR.

This script can:

  1. skip tags in frontmatter because they won't affect build
  2. scan all body texts to find all open tags

Note this script cannot yet skip scanning tags from code blocks wrapped by ~~~ ~~~, but our markdown documents use ``` ``` style of code blocks consistently so it should be okay.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Have version specific changes
  • Might cause conflicts

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot added status/PTAL This PR is ready for reviewing. type/cherry-pick-for-release-4.0 This PR is cherry-picked to release-4.0 from a source PR. labels Sep 3, 2020
@ti-srebot
Copy link
Contributor Author

@yikeke please accept the invitation then you can push to the cherry-pick pull requests.
https://github.com/ti-srebot/docs/invitations

Copy link
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Sep 3, 2020
@yikeke
Copy link
Contributor

yikeke commented Sep 3, 2020

/merge

@ti-srebot ti-srebot added the status/can-merge Indicates a PR has been approved by a committer. label Sep 3, 2020
@ti-srebot
Copy link
Contributor Author

/run-all-tests

@ti-srebot ti-srebot merged commit 2310c2b into pingcap:release-4.0 Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/can-merge Indicates a PR has been approved by a committer. status/LGT1 Indicates that a PR has LGTM 1. status/PTAL This PR is ready for reviewing. type/cherry-pick-for-release-4.0 This PR is cherry-picked to release-4.0 from a source PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants