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.

Sign up for GitHub

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

Jump to bottom

auto_merge property is incorrectly defined #608

Closed
JamieMagee opened this issue Feb 13, 2022 · 2 comments · Fixed by #609
Closed

auto_merge property is incorrectly defined #608

JamieMagee opened this issue Feb 13, 2022 · 2 comments · Fixed by #609
Labels
Type: Bug Something isn't working as documented

Comments

@JamieMagee
Copy link

What happened?

The auto_merge property1 is incorrectly defined as null

What did you expect to happen?

It should be defined as

export interface PullRequestAutoMerge {
	enabled_by: User;
	merge_method: string;
	commit_title: string;
	commit_message: string;	
}

I actually can't find any good documentation on this, other than the rest-api-description2

What the problem might be

The GitHub webhook documentation does not document this as anything other than null, so any update scripts will not be able to find the correct type.

Footnotes

  1. https://github.com/octokit/webhooks/blob/cd6ab2336b4ce9602b93307b2fe95d34cf5f666a/payload-types/schema.d.ts#L4338 ↩

  2. https://github.com/github/rest-api-description ↩
@JamieMagee JamieMagee added the Type: Bug Something isn't working as documented label Feb 13, 2022
@wolfy1339
Copy link
Member

wolfy1339 commented Feb 13, 2022 •
edited
Loading

Thanks for the issue. I will look into it.

wolfy1339 added a commit that referenced this issue Feb 13, 2022
@wolfy1339
fix: auto_merge_property can also be an object
7e82278 
Fixes #608
@wolfy1339 wolfy1339 linked a pull request Feb 13, 2022 that will close this issue
fix: auto_merge property can also be an object, changes property is not always present on project.edited event, add missing runs_rerequestable and rerequestable properties to check_suite.rerequested #609
Merged
wolfy1339 added a commit that referenced this issue Mar 10, 2022
@wolfy1339
feat: updates to repository_vulnerability_alert, check_suite, `wo…
201adb8 
…rkflow_run`, `project`, `branch_protection_rule`, `pull_request.auto_merge_{enabled,disabled}` events

* feat: new `reopen` action for `repository_vulnerability_alert`
Fixes #611
* fix: `auto_merge_property` can also be an object
Fixes #608

* fix: `changes` property is not always present on `project.edited` event
This happens whenever you edit the automation in the project, but don't change the title or body

* fix: add missing `runs_rerequestable` and `rerequestable` to `check_suite.rerequested`
* fix: correct reference to common schema
* fix: add missing properties to `pull_request.auto_merge_{enabled,disabled}` and `branch_protection_rule.edited`
* feat: new `actor` and `triggering_actor` for `workflow_run`s
* fix: add missing properties to `repository_vulnerability_alert`

Adds the following properties:
- number
- state
- fixed_at
- fix_reason

Also normalize properties across actions

* fix: the `sender` for `repository_vulnerability_alert` is GitHub
@octokitbot
Copy link
Collaborator

🎉 This issue has been resolved in version 5.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Bug Something isn't working as documented
Projects
None yet
Milestone
No milestone
3 participants
@JamieMagee @wolfy1339 @octokitbot