Skip to content

Commit d554370

Browse files
committed
HBASE-29878 Improve the Documentation UI (addendum) - fix author check in nightly
The author check fails in nightly build: ``` hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx:154:Also, no `@author` tags - that's a rule. hbase-website/public/book.html:40827:<p>Also, no <code>@author</code> tags - that’s a rule.</p> ``` Ignore files under hbase-website in author checks.
1 parent c78724a commit d554370

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

.github/workflows/yetus-general-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ jobs:
8282
SOURCEDIR: "${{ github.workspace }}/src"
8383
TESTS_FILTER: "checkstyle,javac,pylint,shellcheck,shelldocs,blanks,perlcritic,ruby-lint,rubocop"
8484
YETUSDIR: "${{ github.workspace }}/yetus"
85-
AUTHOR_IGNORE_LIST: "src/main/asciidoc/_chapters/developer.adoc"
85+
AUTHOR_IGNORE_LIST: "hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html"
8686
BLANKS_EOL_IGNORE_FILE: "dev-support/blanks-eol-ignore.txt"
8787
BLANKS_TABS_IGNORE_FILE: "dev-support/blanks-tabs-ignore.txt"
8888
EXCLUDE_TESTS_URL: "https://ci-hbase.apache.org/job/HBase-Find-Flaky-Tests/job/${{ github.base_ref }}/lastSuccessfulBuild/artifact/output/excludes"

.github/workflows/yetus-jdk17-hadoop3-compile-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ jobs:
8181
SOURCEDIR: "${{ github.workspace }}/src"
8282
TESTS_FILTER: "javac,javadoc"
8383
YETUSDIR: "${{ github.workspace }}/yetus"
84-
AUTHOR_IGNORE_LIST: "src/main/asciidoc/_chapters/developer.adoc"
84+
AUTHOR_IGNORE_LIST: "hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html"
8585
BLANKS_EOL_IGNORE_FILE: "dev-support/blanks-eol-ignore.txt"
8686
BLANKS_TABS_IGNORE_FILE: "dev-support/blanks-tabs-ignore.txt"
8787
BUILD_THREAD: "4"

.github/workflows/yetus-jdk17-hadoop3-unit-check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ jobs:
9999
SET_JAVA_HOME: "/usr/lib/jvm/java-17"
100100
SOURCEDIR: "${{ github.workspace }}/src"
101101
YETUSDIR: "${{ github.workspace }}/yetus"
102-
AUTHOR_IGNORE_LIST: "src/main/asciidoc/_chapters/developer.adoc"
102+
AUTHOR_IGNORE_LIST: "hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html"
103103
BLANKS_EOL_IGNORE_FILE: "dev-support/blanks-eol-ignore.txt"
104104
BLANKS_TABS_IGNORE_FILE: "dev-support/blanks-tabs-ignore.txt"
105105
EXCLUDE_TESTS_URL: "https://ci-hbase.apache.org/job/HBase-Find-Flaky-Tests/job/${{ github.base_ref }}/lastSuccessfulBuild/artifact/output/excludes"

dev-support/Jenkinsfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ pipeline {
4444
PROJECT_PERSONALITY = 'https://raw.githubusercontent.com/apache/hbase/master/dev-support/hbase-personality.sh'
4545
PERSONALITY_FILE = 'tools/personality.sh'
4646
// This section of the docs tells folks not to use the javadoc tag. older branches have our old version of the check for said tag.
47-
AUTHOR_IGNORE_LIST = 'src/main/asciidoc/_chapters/developer.adoc'
47+
AUTHOR_IGNORE_LIST = 'hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html'
4848
BLANKS_EOL_IGNORE_FILE = 'dev-support/blanks-eol-ignore.txt'
4949
BLANKS_TABS_IGNORE_FILE = 'dev-support/blanks-tabs-ignore.txt'
5050
// output from surefire; sadly the archive function in yetus only works on file names.

dev-support/Jenkinsfile_GitHub

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ pipeline {
4141
GENERAL_CHECK_PLUGINS = 'all,-javadoc,-jira,-shadedjars,-unit'
4242
JDK_SPECIFIC_PLUGINS = 'compile,github,htmlout,javac,javadoc,maven,mvninstall,shadedjars,unit'
4343
// This section of the docs tells folks not to use the javadoc tag. older branches have our old version of the check for said tag.
44-
AUTHOR_IGNORE_LIST = 'src/main/asciidoc/_chapters/developer.adoc'
44+
AUTHOR_IGNORE_LIST = 'hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html'
4545
BLANKS_EOL_IGNORE_FILE = 'dev-support/blanks-eol-ignore.txt'
4646
BLANKS_TABS_IGNORE_FILE = 'dev-support/blanks-tabs-ignore.txt'
4747
// output from surefire; sadly the archive function in yetus only works on file names.

dev-support/hadoop3-backwards-compatibility-check.Jenkinsfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ pipeline {
135135
SKIP_ERRORPRONE = true
136136
OUTPUT_DIR_RELATIVE = "output-jdk17-hadoop3-backwards-${HADOOP3_VERSION}"
137137
OUTPUT_DIR = "${WORKSPACE}/${OUTPUT_DIR_RELATIVE}"
138-
AUTHOR_IGNORE_LIST = 'src/main/asciidoc/_chapters/developer.adoc'
138+
AUTHOR_IGNORE_LIST = 'hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html'
139139
BLANKS_EOL_IGNORE_FILE = 'dev-support/blanks-eol-ignore.txt'
140140
BLANKS_TABS_IGNORE_FILE = 'dev-support/blanks-tabs-ignore.txt'
141141
// output from surefire; sadly the archive function in yetus only works on file names.

0 commit comments

Comments
 (0)