Skip to content

Commit 8d29c26

Browse files
authored
.github: add a PR template (#709)
* .github: add a PR template Signed-off-by: Ran <[email protected]> * exclude .github from ci Signed-off-by: Ran <[email protected]>
1 parent 12595f5 commit 8d29c26

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

.github/pull_request_template.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!--When you publish a blog or case study, be sure of the following-->
2+
3+
- [ ] I have added necessary CTA buttons
4+
- [ ] I have resized the images to <= 200 KB
5+
- [ ] I have included necessary SEO keywords in filenames

.github/workflows/ci.yml

+7-7
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ jobs:
1717
git remote add upstream https://github.com/pingcap/blog.git;
1818
git fetch upstream;
1919
wget https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-file-encoding.py;
20-
python3 check-file-encoding.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md')
20+
python3 check-file-encoding.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
2121
- name: "Check front matters"
2222
run:
23-
python3 ./hack/check-front-matters.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md')
23+
python3 ./hack/check-front-matters.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
2424
- name: Markdown lint
2525
uses: avto-dev/markdown-lint@v1
2626
with:
@@ -29,24 +29,24 @@ jobs:
2929
- name: "Check control characters"
3030
run:
3131
wget https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-control-char.py;
32-
python3 check-control-char.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md')
32+
python3 check-control-char.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
3333
- name: "Check unclosed tags"
3434
run:
3535
wget https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-tags.py;
36-
python3 check-tags.py $(git diff-tree --name-only --no-commit-id -r upstream/master...HEAD -- '*.md')
36+
python3 check-tags.py $(git diff-tree --name-only --no-commit-id -r upstream/master...HEAD -- '*.md' ':(exclude).github/*')
3737
- name: "Check Chinese punctuation"
3838
run:
3939
wget https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-zh-punctuation.py;
4040
pip3 install zhon;
41-
python3 check-zh-punctuation.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md')
41+
python3 check-zh-punctuation.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
4242
- name: Verify internal links
4343
run: ./hack/verify-links-doc.sh
4444
#- name: Verify internal link anchors
4545
# run: ./hack/verify-link-anchors.sh
4646
- name: "Check manual line breaks"
4747
run:
4848
wget https://raw.githubusercontent.com/pingcap/docs/master/scripts/check-manual-line-breaks.py;
49-
python3 check-manual-line-breaks.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md')
49+
python3 check-manual-line-breaks.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')
5050
- name: "Check < symbols"
5151
run:
52-
python3 ./hack/check-special-marks.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md')
52+
python3 ./hack/check-special-marks.py $(git diff-tree --name-only --no-commit-id -r upstream/master..HEAD -- '*.md' ':(exclude).github/*')

0 commit comments

Comments
 (0)