Skip to content

HBASE-29878 Improve the Documentation UI (addendum) - fix author check in nightly#7952

Merged
PDavid merged 5 commits into
apache:masterfrom
PDavid:HBASE-29878-author-ignore-nightly
Jun 25, 2026
Merged

HBASE-29878 Improve the Documentation UI (addendum) - fix author check in nightly#7952
PDavid merged 5 commits into
apache:masterfrom
PDavid:HBASE-29878-author-ignore-nightly

Conversation

@PDavid

@PDavid PDavid commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

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>

https://ci-hbase.apache.org/job/HBase%20Nightly/job/master/1420/General_20Nightly_20Build_20Report/

Fix:
Ignore files under hbase-website in author checks.

@PDavid PDavid self-assigned this Mar 17, 2026
@PDavid

PDavid commented Mar 17, 2026

Copy link
Copy Markdown
Contributor Author

Hmm, it seems that the @author check is still failing in the general check. Does it checks it on master or on the branch? 🤔

@PDavid PDavid requested review from Apache9 and ndimiduk March 17, 2026 11:24
@Apache9

Apache9 commented Mar 17, 2026

Copy link
Copy Markdown
Contributor
13:hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx:154:Also, no `@author` tags - that's a rule.
14:hbase-website/public/book.html:40827:<p>Also, no <code>@author</code> tags - that’s a rule.</p>

Seems still the same error.

@Apache9

Apache9 commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

This is the log console output, seems we have already used the new config?

AUTHOR_IGNORE_LIST=hbase-website/app/pages/_docs/docs/_mdx/(multi-page)/building-and-developing/developer-guidelines.mdx,hbase-website/public/book.html

@Apache9

Apache9 commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Oh wait a minute, what is the syntax for passing multiple ignore files in?

@Apache9

Apache9 commented Mar 17, 2026

Copy link
Copy Markdown
Contributor

Strange, it is comma separated... @ndimiduk do you have any ideas on this?

function author_parse_args
{
  declare i

  for i in "$@"; do
    case ${i} in
      --author-ignore-list=*)
        delete_parameter "${i}"
        yetus_comma_to_array AUTHOR_IGNORE_LIST "${i#*=}"
      ;;
    esac
  done
}

@PDavid

PDavid commented Mar 17, 2026

Copy link
Copy Markdown
Contributor Author

Maybe we need space separator, let's see. 🙈

@PDavid PDavid force-pushed the HBASE-29878-author-ignore-nightly branch from 2189d32 to d554370 Compare March 20, 2026 09:20
@ndimiduk

Copy link
Copy Markdown
Member

https://issues.apache.org/jira/browse/YETUS-1266

@ndimiduk

Copy link
Copy Markdown
Member

apache/yetus#366

@PDavid

PDavid commented Mar 24, 2026

Copy link
Copy Markdown
Contributor Author

Many thanks @ndimiduk for your fix in Yetus! 👍

I guess we will have to wait until the new Yetus release and then upgrade Yetus in HBase, right?

@ndimiduk

Copy link
Copy Markdown
Member

Many thanks @ndimiduk for your fix in Yetus! 👍

I guess we will have to wait until the new Yetus release and then upgrade Yetus in HBase, right?

Yes, unfortunately. Maybe you can re-implement the fix as a function override in our personality file -- bash is extremely monkey-patchable.

@PDavid PDavid force-pushed the HBASE-29878-author-ignore-nightly branch from d554370 to 140bee9 Compare March 27, 2026 12:03
@PDavid

PDavid commented Mar 27, 2026

Copy link
Copy Markdown
Contributor Author

Hi @ndimiduk,

I tried to do the monkey-patching thing but to be honest I'm not sure if I'm doing it right. It does not work for sure. I cannot see my newly added debug messages in the output log. 🙈

Can you please help in this a bit?

@PDavid PDavid force-pushed the HBASE-29878-author-ignore-nightly branch 2 times, most recently from fa87a7e to 23ba7a8 Compare April 17, 2026 17:29
@Apache9

Apache9 commented Apr 18, 2026

Copy link
Copy Markdown
Contributor

We can try to use the lastest master of yetus to see if it helps? If so, we can push yetus to release a new version.

@PDavid PDavid force-pushed the HBASE-29878-author-ignore-nightly branch from 97488d8 to 00e65f0 Compare April 20, 2026 11:40
@PDavid PDavid force-pushed the HBASE-29878-author-ignore-nightly branch from 00e65f0 to 37ca6e9 Compare May 5, 2026 09:27
@PDavid PDavid added the test-yetus-prerelease Test the precommit run against an unreleased apache/yetus revision. See HBASE-30133. label May 5, 2026
@PDavid PDavid marked this pull request as ready for review May 5, 2026 09:34
PDavid added 2 commits June 24, 2026 14:46
…k 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.
YETUS-1266 Escape regex metacharacters in author plugin ignore list

The author_postcompile function writes --author-ignore-list entries directly into a grep -E filter file without escaping. Filenames containing regex metacharacters (parentheses, brackets, etc.) are silently misinterpreted as pattern syntax, causing those files to pass through unfiltered.
@PDavid PDavid force-pushed the HBASE-29878-author-ignore-nightly branch from 37ca6e9 to 09388f4 Compare June 24, 2026 12:49

@ndimiduk ndimiduk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything that I can make better back on the Yetus side?

Comment thread dev-support/hbase-personality.sh Outdated
declare -r appname=$(basename "${BASH_SOURCE-$0}")
declare -a globalignore

big_console_header "*** HBase Monkey-Patch: author_postcompile ***"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lolsob

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, yes, I'll need to remove this. 😄

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this proves that the monkey-patch function IS actually invoked:
image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the debug logging now.

@PDavid

PDavid commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

General question:

Turns out for GitHup PR-s, the author_patchfile function is invoked which is for patch mode. So that is a different function than what we have the fix in yetus and the monkey-patch for. This means that the author check will fail on the PR.
But the nightly author check should be fixed by this patch.

Is it OK to merge it like this (as I hope it will fix the nightly)?
What do you all think?

@PDavid

PDavid commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

I tried to hack something for the author_patchfile function (which is for patch mode) with Claude Code as I'm not too experienced with Yetus but it was not successful unfortunately. 😢

@PDavid

PDavid commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

@ndimiduk and @Apache9 can you please have a look?

Comment thread dev-support/hbase-personality.sh Outdated
@PDavid PDavid merged commit 3dbfe52 into apache:master Jun 25, 2026
7 of 8 checks passed
@PDavid PDavid deleted the HBASE-29878-author-ignore-nightly branch June 25, 2026 05:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

test-yetus-prerelease Test the precommit run against an unreleased apache/yetus revision. See HBASE-30133.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants