add a circleci integration: check unclosed tags #3786
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 16 commits
September 1, 2020 18:37
This reverts commit 6056fb3.
yikeke
changed the title
yikeke
changed the title
yikeke
changed the title
yikeke
changed the title
ti-srebot
approved these changes
Sep 3, 2020
ti-srebot
pushed a commit
to ti-srebot/docs
that referenced
this pull request
Sep 3, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
9 tasks
|
cherry pick to release-2.1 in PR #3806 |
ti-srebot
pushed a commit
to ti-srebot/docs
that referenced
this pull request
Sep 3, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
9 tasks
|
cherry pick to release-3.0 in PR #3807 |
9 tasks
ti-srebot
pushed a commit
to ti-srebot/docs
that referenced
this pull request
Sep 3, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
9 tasks
|
cherry pick to release-3.1 in PR #3808 |
9 tasks
ti-srebot
pushed a commit
to ti-srebot/docs
that referenced
this pull request
Sep 3, 2020
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
9 tasks
|
cherry pick to release-4.0 in PR #3809 |
This was referenced Sep 3, 2020
yikeke
commented
Sep 3, 2020
| result_findall = re.findall(r'<([^\n`>]*)>', content) | ||
| if len(result_findall) == 0: | ||
| # print("The edited markdown file " + filename + " has no tags!\n") | ||
| status_code = 0 |
There was a problem hiding this comment.
This line has been modified since merged.
ti-srebot
added a commit
that referenced
this pull request
Sep 3, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.Note: authors may find unexpectedly changed files in the CI check if their branches are outdated, merge master branch will help in such scenario. (from #1406)
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?