Skip to content

CI: add Vale to apply Google style guide to all md files #4141

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

Draft
wants to merge 34 commits into
base: master
Choose a base branch
from

Conversation

CharLotteiu
Copy link
Contributor

@CharLotteiu CharLotteiu commented Nov 3, 2020

What is changed, added or deleted? (Required)

Add Vale in CircleCI to apply the Google developer documentation style guide to all md files in the repo.

Vale is highly customizable so it is possible for us to set our own rules in yaml files according to our needs.

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)?

Do your changes match any of the following descriptions?

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

@CharLotteiu CharLotteiu changed the title add vale ci test files and style files CI: add Vale to apply Google style guide to all md files Nov 4, 2020
@CharLotteiu CharLotteiu requested review from yikeke and lilin90 November 4, 2020 06:32
@CharLotteiu CharLotteiu added needs-cherry-pick-2.1 status/PTAL This PR is ready for reviewing. translation/no-need No need to translate this PR. labels Nov 4, 2020
@CharLotteiu CharLotteiu marked this pull request as ready for review November 4, 2020 06:33
@yikeke yikeke removed their request for review May 12, 2021 07:58
@ti-chi-bot ti-chi-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jul 13, 2021
@TomShawn TomShawn marked this pull request as draft August 13, 2021 08:27
@ti-chi-bot ti-chi-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 13, 2021
@ti-chi-bot
Copy link
Member

@CharLotteiu: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 30, 2021
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ CharLotteiu
❌ yikeke


yikeke seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@qiancai
Copy link
Collaborator

qiancai commented Apr 6, 2023

Removed the needs-cherry-pick-release-2.1 label because the v2.1 docs have been archived at https://docs-archive.pingcap.com/tidb/v2.1 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Apr 6, 2023

Removed the needs-cherry-pick-release-3.1 label because the v3.1 docs have been archived at https://docs-archive.pingcap.com/tidb/v3.1 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Oct 20, 2023

Removed the needs-cherry-pick-release-3.0 label because the v3.0 docs have been archived at https://docs-archive.pingcap.com/zh/tidb/v3.0 and will no longer receive new updates.

Copy link

ti-chi-bot bot commented Jan 26, 2024

@CharLotteiu: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 3f2dfd6 link true /test pull-verify

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@qiancai
Copy link
Collaborator

qiancai commented Apr 15, 2024

Removed the needs-cherry-pick-release-4.0 label because the v4.0 docs have been archived at https://docs-archive.pingcap.com/tidb/v4.0 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Apr 15, 2024

Removed the needs-cherry-pick-release-5.0 label because the v5.0 docs have been archived at https://docs-archive.pingcap.com/tidb/v5.0 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Jul 19, 2024

Removed the needs-cherry-pick-release-5.1 label because the v5.1 docs have been archived at https://docs-archive.pingcap.com/tidb/v5.1 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Aug 30, 2024

Removed the needs-cherry-pick-release-5.2 label because the v5.2 docs have been archived at https://docs-archive.pingcap.com/tidb/v5.2 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Dec 30, 2024

Removed the needs-cherry-pick-release-5.3 label because the v5.3 docs have been archived at https://docs-archive.pingcap.com/tidb/v5.3 and will no longer receive new updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/PTAL This PR is ready for reviewing. translation/no-need No need to translate this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants