feat!: Add merge queue parameters to repository ruleset #3253
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gmlewis
changed the title
gmlewis
added
NeedsReview
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3253 +/- ##
==========================================
- Coverage 97.72% 92.94% -4.78%
==========================================
Files 153 171 +18
Lines 13390 11663 -1727
==========================================
- Hits 13085 10840 -2245
- Misses 215 729 +514
- Partials 90 94 +4 ☔ View full report in Codecov by Sentry. |
gmlewis
reviewed
Aug 28, 2024
| @@ -110,6 +110,19 @@ type RuleRequiredStatusChecks struct { | |||
| IntegrationID *int64 `json:"integration_id,omitempty"` | |||
| } | |||
|
|
|||
| // MergeQueueRuleParameters represents the merge_queue rule parameters. | |||
| type MergeQueueRuleParameters struct { | |||
There was a problem hiding this comment.
@zepeng811 - should any of these parameters be optional (and therefore pointers with the omitempty JSON tag added)?
There was a problem hiding this comment.
@gmlewis did a quick test and seems like it must be all or nothing
adding all parameters like this worked:
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/$ORG/$REPO/rulesets \
-d '{"name":"merge queue test ruleset","target":"branch","enforcement":"active","conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]}},"rules":[{"type":"merge_queue","parameters":{"check_response_timeout_minutes":35,"grouping_strategy":"HEADGREEN","max_entries_to_build":8,"max_entries_to_merge":4,"merge_method":"SQUASH","min_entries_to_merge":2,"min_entries_to_merge_wait_minutes":13}}]}'
but if any parameter was removed, like:
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/$ORG/$REPO/rulesets \
-d '{"name":"merge queue test ruleset 2","target":"branch","enforcement":"active","conditions":{"ref_name":{"include":["refs/heads/main","refs/heads/master"],"exclude":["refs/heads/dev*"]}},"rules":[{"type":"merge_queue","parameters":{"check_response_timeout_minutes":35,"grouping_strategy":"HEADGREEN","max_entries_to_build":8,"max_entries_to_merge":4,"merge_method":"SQUASH","min_entries_to_merge":2}}]}'
then the API will error:
{
"message": "Invalid request.\n\nInvalid property /rules/0: data matches no possible input. See `documentation_url`.",
"documentation_url": "https://docs.github.com/rest/repos/rules#create-a-repository-ruleset",
"status": "422"
}
gmlewis
approved these changes
Aug 28, 2024
There was a problem hiding this comment.
Thank you, @zepeng811 !
LGTM.
Awaiting second LGTM+Approval from any other contributor to this repo before merging.
ali-kafel
approved these changes
Sep 3, 2024
tomleicircle
approved these changes
Sep 3, 2024
|
Thank you, @ali-kafel and @tomleicircle ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #3225.
BREAKING CHANGE:
NewMergeQueueRulenow takes one parameter:*MergeQueueRuleParameters.Summary
closes: #3225
(I'm the same author as the assignee of the issue @zhpeng811, but submitting the
PR using my corporate account)
Details
This PR adds merge queue parameter configurations to the repository branch ruleset.
an attempt was also made for organization ruleset but was later determined that GitHub currently does not support merge queue configurations at the organizational level. Configs related to merge queue in tests was removed as the result.
Testing
General
Ran the required scripts on step 4 of the CONTRIBUTING.md file
Details
Repository Ruleset
Manual:
Tested with the following test code, both with and without including the specific parameters, and verified in the UI.
Expand to view code
Unit Test:
A unit test already exist for merge queue without parameters, 2 more tests were added (1 success case and 1 failure case with the incorrect parameter type)
Organization Ruleset
Was trying to create a org ruleset with merge queue rule using the following curl
Expand for curl
but got the following error:
I cross referenced with the UI page and did not notice a branch rule for merge queue, which conflicts with the REST API documentation for org rulesets, so seems like GitHub currently does not support merge queue configuration on the org level ruleset. Reported the issue to GitHub community: https://github.com/orgs/community/discussions/137097