Skip to content

Commit

Permalink
merge from upstream master
Browse files Browse the repository at this point in the history
  • Loading branch information
ti-srebot authored Dec 3, 2021
2 parents 66689a1 + c7daf48 commit 5cf1da6
Show file tree
Hide file tree
Showing 155 changed files with 5,781 additions and 2,028 deletions.
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ By default, **CHOOSE MASTER ONLY** so your changes will be applied to the next T
For details, see [tips for choosing the affected versions](https://github.com/pingcap/docs/blob/master/CONTRIBUTING.md#guideline-for-choosing-the-affected-versions).

- [ ] master (the latest development version)
- [ ] v5.3 (TiDB 5.3 versions)
- [ ] v5.2 (TiDB 5.2 versions)
- [ ] v5.1 (TiDB 5.1 versions)
- [ ] v5.0 (TiDB 5.0 versions)
Expand Down
18 changes: 18 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: ci

on: [pull_request]

jobs:

pull:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '12'
- name: Verify internal links
run: ./scripts/verify-links.sh
- name: Verify internal link anchors
run: ./scripts/verify-link-anchors.sh
54 changes: 27 additions & 27 deletions .github/workflows/link-check.yaml
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# name: external-link-check
name: external-link-check

# on: [pull_request]
on: [pull_request]

# jobs:
# base:
# runs-on: ubuntu-18.04
# steps:
# - name: Check out code
# uses: actions/checkout@v2
jobs:
base:
runs-on: ubuntu-20.04
steps:
- name: Check out code
uses: actions/checkout@v2

# # NOTE:
# # - the check process can be very fast,
# # but if `-c` is too large then `Too Many Requests (HTTP error 429)` may be reported from `https://github.com/*`.
# # - we hardcode `--document-root` to `/github/workspace` in the container now.
# # - we use `http://172.*` as sample addresses in some docs, so we need to exclude them.
# - name: Check external links
# id: lc
# uses: peter-evans/link-checker@v1
# with:
# args: -c 32 -d /github/workspace -r -x "http://172.*|https://github.com/.*/pull/.*|https://github.com/.*/issues/.*|https://github.com/[^.\n]*$|http://127.0.0.1.*|http://localhost.*|http://.*:.*|https://static.googleusercontent.com/media/research.google.com/.*|https://www.crunchbase.com/organization/.*|http://www.brendangregg.com.*|https://blog.csdn.net.*|http://mysql-cocoa.sourceforge.net.*|https://tools.ietf.org.*|http://code.google.com.*|https://spark.apache.org.*|https://www.caasdata.com/|https://www.linkedin.com/company/.*|https://sea-group.org/.*|https://octave.sourceforge.io/database/index.html|https://www.teld.cn/|http://gnade.sourceforge.net/|https://en.wikipedia.org/wiki/WeBank_\(China|https://twitter.com/PingCAP|http://www.webgraphviz.com/|http://octave.sourceforge.net/database/index.html|http://www.ymt.com/|http://www.alhem.net/project/mysql/|https://www.reddit.com/r/TiDB|http://www.189.cn/sh/|https://dev.mysql.com/doc/refman/5.7/en/connector-odbc-info.html|https://asktug.com/_/tidb-performance-map/#/|https://commons.apache.org/proper/commons-dbcp/|https://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html|https://en.wikipedia.org/wiki/Plane_\(Unicode|.*.md" .
# NOTE:
# - the check process can be very fast,
# but if `-c` is too large then `Too Many Requests (HTTP error 429)` may be reported from `https://github.com/*`.
# - we hardcode `--document-root` to `/github/workspace` in the container now.
# - we use `http://172.*` as sample addresses in some docs, so we need to exclude them.
- name: Check external links
id: lc
uses: peter-evans/link-checker@v1
with:
args: -c 32 -d /github/workspace -r -x "http://172.*|https://github.com/.*/pull/.*|https://github.com/.*/issues/.*|https://github.com/[^.\n]*$|http://127.0.0.1.*|http://localhost.*|http://.*:.*|https://static.googleusercontent.com/media/research.google.com/.*|https://www.crunchbase.com/organization/.*|http://www.brendangregg.com.*|https://blog.csdn.net.*|http://mysql-cocoa.sourceforge.net.*|https://tools.ietf.org.*|http://code.google.com.*|https://spark.apache.org.*|https://www.caasdata.com/|https://www.linkedin.com/company/.*|https://sea-group.org/.*|https://octave.sourceforge.io/database/index.html|https://www.teld.cn/|http://gnade.sourceforge.net/|https://en.wikipedia.org/wiki/WeBank_\(China|https://twitter.com/PingCAP|http://www.webgraphviz.com/|http://octave.sourceforge.net/database/index.html|http://www.ymt.com/|http://www.alhem.net/project/mysql/|https://www.reddit.com/r/TiDB|http://www.189.cn/sh/|https://dev.mysql.com/doc/refman/5.7/en/connector-odbc-info.html|https://asktug.com/_/tidb-performance-map/#/|https://commons.apache.org/proper/commons-dbcp/|https://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html|https://en.wikipedia.org/wiki/Plane_\(Unicode|.*.md" .

# - name: Fail if there were external link errors
# if: ${{ steps.lc.outputs.exit_code }}
# run: |
# echo "Please check the broken links reported in the previous step \"Check external links\"."
# exit ${{ steps.lc.outputs.exit_code }}
# # Debug via SSH if previous steps failed
# #- name: Set up tmate session
# # if: ${{ failure() }}
# # uses: mxschmitt/action-tmate@v2
- name: Fail if there were external link errors
if: ${{ steps.lc.outputs.exit_code }}
run: |
echo "Please check the broken links reported in the previous step \"Check external links\"."
exit ${{ steps.lc.outputs.exit_code }}
# Debug via SSH if previous steps failed
#- name: Set up tmate session
# if: ${{ failure() }}
# uses: mxschmitt/action-tmate@v2
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Currently, we maintain the following versions of TiDB documentation, each with a
| Docs branch name | Version description |
| :--- | :--- |
| `master` branch | the latest development version |
| `release-5.3` branch | the 5.3 stable version |
| `release-5.2` branch | the 5.2 stable version |
| `release-5.1` branch | the 5.1 stable version |
| `release-5.0` branch | the 5.0 stable version |
Expand All @@ -53,6 +54,7 @@ Currently, we maintain the following versions of TiDB documentation, each with a
- If your changes apply to only one docs version, just submit a PR to the corresponding version branch.

- If your changes apply to multiple docs versions, you don't have to submit a PR to each branch. Instead, after you submit your PR, trigger the ti-chi-bot to submit a PR to other version branches by adding one or several of the following labels as needed. Once the current PR is merged, ti-chi-bot will start to work.
- `needs-cherry-pick-5.3` label: ti-chi-bot will submit a PR to the `release-5.3` branch.
- `needs-cherry-pick-5.2` label: ti-chi-bot will submit a PR to the `release-5.2` branch.
- `needs-cherry-pick-5.1` label: ti-chi-bot will submit a PR to the `release-5.1` branch.
- `needs-cherry-pick-5.0` label: ti-chi-bot will submit a PR to the `release-5.0` branch.
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Currently, we maintain the following versions of TiDB documentation in different
| Branch name | TiDB docs version |
| :---------|:----------|
| [`master`](https://github.com/pingcap/docs/tree/master) | The latest development version |
| [`release-5.3`](https://github.com/pingcap/docs/tree/release-5.3) | 5.3 stable version |
| [`release-5.2`](https://github.com/pingcap/docs/tree/release-5.2) | 5.2 stable version |
| [`release-5.1`](https://github.com/pingcap/docs/tree/release-5.1) | 5.1 stable version |
| [`release-5.0`](https://github.com/pingcap/docs/tree/release-5.0) | 5.0 stable version |
Expand Down
Loading

0 comments on commit 5cf1da6

Please sign in to comment.