Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

ISSUE-15797: PIP 176: Refactor Doc Bot #4280

Open
4 tasks
sijie opened this issue May 26, 2022 · 0 comments
Open
4 tasks

ISSUE-15797: PIP 176: Refactor Doc Bot #4280

sijie opened this issue May 26, 2022 · 0 comments

Comments

@sijie
Copy link
Member

sijie commented May 26, 2022

Original Issue: apache#15797


PIP

PIP 176: Refactor Doc Bot to Improve Efficiency of Managing Doc

Issues (new)

  • P0: doc bot check is pending or waiting and documentation label check is changed to label check after it is set to required.

This blocks many PRs, eg. apache#16298, apache#16023

This might be caused by GitHub Action limitations https://stackoverflow.com/questions/52200096/github-pull-request-waiting-for-status-to-be-reported

Can you please take a look at it at your earliest convenience? Thank you!

  • P1: when the PR description is empty and the PR author selects labels from Labels, the doc bot should work normally.

  • P2: configure the doc bot to other branches except for master
    - [x] 2.10. Obsever the results and set for other branches if it works well
    - [ ] 2.9
    - [ ] 2.8
    - [ ] 2.7

Issues can't be resolved

Issues (old)

When fixing apache#15732, @maxsxu found that the doc Bot was implemented by modifying dist rather than src, which makes it hard to maintain and scale.

Consequently, he suggests refactoring the doc Bot along with resolving the following issues in Bot:

Scenario 1

Issue

This PR was marked with doc-related labels and then removed. No doc-related label is marked for this PR.

Expected behavior

In this case, this PR should be labeled w/ doc-label-missing.

image

Scenario 2

Issue

Doc Bot only works for master change.

Expected behavior

Doc Bot should work for all branches and label all PRs.

image

Scenario 3

Issue

Bot labels this PR with several doc labels.

Expected behavior

Bot should label a PR with only a doc label.

image

Improvements

Set documentation label check as one of the GitHub checks.

References

Pulsar Bot

@sijie sijie changed the title ISSUE-15797: Refactor doc Bot ISSUE-15797: PIP 176: Refactor Doc Bot Aug 7, 2022
@sijie sijie added the Stale label Aug 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant