Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wiki: GerritBot vs gopherbot #73330

Open
abitrolly opened this issue Apr 11, 2025 · 3 comments
Open

wiki: GerritBot vs gopherbot #73330

abitrolly opened this issue Apr 11, 2025 · 3 comments
Labels
Documentation Issues describing a change to documentation. help wanted
Milestone

Comments

@abitrolly
Copy link

https://go.dev/wiki/GerritBot vs https://go.dev/wiki/gopherbot

I see that only GerritBot is said to sync PRs, but real comments about PR being synced are made by @gopherbot (#73314 (comment)). If they too work together, it would be nice to document how, ideally with mermaid diagram. And if GerritBot is not commenting at all, why is it called *Bot in the first place?

@gabyhelp gabyhelp added the Documentation Issues describing a change to documentation. label Apr 11, 2025
@prattmic
Copy link
Member

The name GerritBot is used for two things:

The name gopherbot is used for two things:

When the gerritbot program posts comments on GitHub it uses the gopherbot GitHub account rather than having a dedicated GitHub. Note that a third program, x/build/cmd/watchflakes also posts using the gopherbot GitHub account.

I agree that this is confusing. Why is it this way? I don't know the history, but in practice I don't think there is a practical reason that the three programs need to use different GitHub accounts. In fact, there is no reason that cmd/gerritbot and cmd/watchflakes couldn't be part of cmd/gopherbot, it is simply an implementation detail.

In the immediate term, I agree that https://go.dev/wiki/GerritBot should mention that it comments on GitHub as gopherbot. In the longer term, in my opinion we shouldn't expose the implementation details of where the automation happens. i.e., IMO https://go.dev/wiki/GerritBot should simply be titled something like "GitHub Pull Requests".

@prattmic prattmic added this to the Unreleased milestone Apr 14, 2025
@abitrolly
Copy link
Author

Thanks for the explanation. It really clarifies the state of things.

we shouldn't expose the implementation details of where the automation happens. i.e., IMO https://go.dev/wiki/GerritBot should simply be titled something like "GitHub Pull Requests".

The idea was is that folks at GerritHub could reuse the workflow, which would help issues like nfs-ganesha/nfs-ganesha#1264

@prattmic
Copy link
Member

cmd/gerritbot has a fair amount of Go-specific parts, but it could probably be a starting point for a more general solution other projects could use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues describing a change to documentation. help wanted
Projects
None yet
Development

No branches or pull requests

3 participants