Add new `pr-publish` command by jonchang · Pull Request #7202 · Homebrew/brew

jonchang · 2020-03-22T02:23:39Z

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same change?
Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes? Here's an example.
Have you successfully run brew style with your changes locally?
Have you successfully run brew tests with your changes locally?

This is the maintainer-facing command we need before switching over to GitHub Actions with self-hosted runners.

This new command issues a single GitHub API call to fire the repository_dispatch event, which starts this workflow in Homebrew/core: https://github.com/Homebrew/homebrew-core/blob/master/.github/workflows/publish-commit-bottles.yml

The workflow:

Gets the details of the user who fired the dispatch event (name and email address)
Authenticates against GitHub using the BrewTestBot personal access token and checks out Homebrew/core
Downloads artifacts (bottles) associated with the pull request specified in brew pr-publish
Uploads those bottles to Bintray using brew test-bot --ci-upload --publish (c.f. test-bot: use separate API call on publish homebrew-test-bot#344)
Modifies all new commits to set the committer to the user who fired the dispatch event and signs off the last commit (similar to brew pull --bottle)
Pushes the new commits to master

Maintainers who want to opt-in to the new workflow should simply run brew pr-publish <pr> [<pr> ...]. This will use the GitHub Actions bottles rather than the Jenkins bottles. The Jenkins workflow can still be used with brew pull --bottle <pr>.

Example of a successful run:

Pull request: prettier 2.0.1 homebrew-core#52012
Actions run: https://github.com/Homebrew/homebrew-core/runs/525213544?check_suite_focus=true
Bottling commit: Homebrew/homebrew-core@d5917cf

dawidd6 · 2020-03-22T08:53:47Z

But Jon, you didn't merge the PR commit to master. Mednafen is still on previous version, while the bottle is on the newest.

MikeMcQuaid

A few suggested style tweaks/cleanups but looks good, great work again!

MikeMcQuaid · 2020-03-22T09:11:41Z

+      switch :verbose
+    end
+  end
+
+  def pr_publish
+    pr_publish_args.parse
+
+    odie "You need to specify a pull request number!" if Homebrew.args.named.empty?


Suggested change

switch :verbose

end

end

def pr_publish

pr_publish_args.parse

odie "You need to specify a pull request number!" if Homebrew.args.named.empty?

switch :verbose

named 1

end

end

def pr_publish

pr_publish_args.parse

@jonchang This DSL would be preferable to use here

MikeMcQuaid · 2020-03-22T09:12:19Z

    comments.any? { |comment| comment["body"].eql?(body) }
  end

+  def dispatch(user, repo, event, **payload)


Suggested change

def dispatch(user, repo, event, **payload)

def repo_dispatch_event(user, repo, event, **payload)

or

Suggested change

def dispatch(user, repo, event, **payload)

def dispatch_event(user, repo, event, **payload)

MikeMcQuaid · 2020-03-22T09:13:17Z

+      tap = Tap.fetch(user, repo) if repo.match?(HOMEBREW_OFFICIAL_REPO_PREFIXES_REGEX)
+      odie "Not a GitHub pull request: #{arg}" unless issue
+      ohai "Dispatching #{tap} pull request ##{issue}"
+      GitHub.dispatch(user, repo, "Publish ##{issue}", pull_request: issue)


Could this (or a line after) output a URL that you can use to check progress? If not possible: no worries.

This unfortunately returns 204 No Content. We'd have to find it using another API call.

😭. Even if it outputs the full PR URL somewhere that might be nice. Where does the "action" show up; just in the actions tab on the repo?

Yup, just in the Actions tab. You can filter by actor and workflow type though which can help. In Linuxbrew/core we have @BrewTestBot ping the requestor when the upload job fails. This could be added to the workflow in Homebrew/core:

https://github.com/Homebrew/linuxbrew-core/blob/3d460c215425e7d1547865ad0c2f5b4b7bce7dd7/.github/workflows/upload-bottles.yml#L165-L173
https://github.com/Homebrew/linuxbrew-core/pull/19902#issuecomment-601881442

Yeh, this would be great to have there too 👍

jonchang · 2020-03-22T09:18:23Z

But Jon, you didn't merge the PR commit to master. Mednafen is still on previous version, while the bottle is on the newest.

Fixed!

Moisan · 2020-03-22T20:19:14Z

Great work! I've tested it and noticed that in the bottle commit, the sign-off email is different than what we usually see when using brew pull --bottle:

Signed-off-by: Thierry Moisan <31669+Moisan@users.noreply.github.com>

Is that expected?

jonchang · 2020-03-22T22:56:37Z

Great work! I've tested it and noticed that in the bottle commit, the sign-off email is different than what we usually see when using brew pull --bottle:
Signed-off-by: Thierry Moisan <31669+Moisan@users.noreply.github.com>
Is that expected?

Yes, it either uses your public GitHub email address or your noreply address to associate the commit with your account. See https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address

Bo98 · 2020-03-23T18:16:27Z

Just to check: presumably this means that any sort of squashing, commit rewording etc will no longer be possible and will now require asking the pull request author to do so and run a new CI build?

jonchang · 2020-03-24T01:21:51Z

Just to check: presumably this means that any sort of squashing, commit rewording etc will no longer be possible and will now require asking the pull request author to do so and run a new CI build?

With this workflow, yes. Either a maintainer or the pull request author would need to make these changes on the pull request branch. I'm not sure how we could do something similar to our current workflow with GitHub Actions.

Bo98 · 2020-03-24T02:11:54Z

I suppose the payload could be used, but the different scenarios probably would make it get complex very fast.

utils/github: add repository_dispatch API

4bb66c1

jonchang requested a review from MikeMcQuaid March 22, 2020 02:25

jonchang added 2 commits March 22, 2020 13:35

dev-cmd: new pr-publish command

86f245e

manpages: update for brew pr-publish

e08ffb3

MikeMcQuaid approved these changes Mar 22, 2020

View reviewed changes

jonchang merged commit 5f53180 into Homebrew:master Mar 24, 2020

jonchang deleted the pr-publish branch March 24, 2020 01:24

jonchang mentioned this pull request Mar 24, 2020

pr-publish: tweak wording and function names #7212

Merged

6 tasks

This was referenced Mar 29, 2020

Add new pr-pull command #7236

Merged

Migrate Homebrew/homebrew-core CI to GitHub Actions CI #6255

Closed

lock bot added the outdated PR was locked due to age label Apr 25, 2020

lock bot locked as resolved and limited conversation to collaborators Apr 25, 2020

	def dispatch(user, repo, event, **payload)
	def repo_dispatch_event(user, repo, event, **payload)

	def dispatch(user, repo, event, **payload)
	def dispatch_event(user, repo, event, **payload)

Uh oh!

Conversation

jonchang commented Mar 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dawidd6 commented Mar 22, 2020

Uh oh!

MikeMcQuaid left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jonchang commented Mar 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Moisan commented Mar 22, 2020

Uh oh!

jonchang commented Mar 22, 2020

Uh oh!

Bo98 commented Mar 23, 2020

Uh oh!

jonchang commented Mar 24, 2020

Uh oh!

Bo98 commented Mar 24, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jonchang commented Mar 22, 2020 •

edited

Loading

jonchang commented Mar 22, 2020 •

edited

Loading