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

[Vcpkg] clean PR clutters commit #40169

Closed
wants to merge 7 commits into from

Conversation

FrankXie05
Copy link
Contributor

@FrankXie05 FrankXie05 commented Jul 30, 2024

Fix #37352

@FrankXie05 FrankXie05 added info:internal This PR or Issue was filed by the vcpkg team. category:infrastructure Pertaining to the CI/Testing infrastrucutre labels Jul 30, 2024
@dg0yt
Copy link
Contributor

dg0yt commented Jul 30, 2024

The problem is not in the contributor's commit messages, and thus it cannot be caught with regular PR checks because that commit message doesn't exist at that time.
The problem is in the commit message of the Squash Merge Commit which is synthetized from the initial post.

The initial post is based on the PR draft message which is unfortunately designed to have commented sections. PR checks would have to fetch the PR's comment via GH API. But you can't really suggest to remove the commented sections which were just suggested by the template.

@FrankXie05
Copy link
Contributor Author

@dg0yt
This mechanism is mainly to prompt maintainers to check whether the body contains undeleted notes section, helping to clean up the messy information in the commit.

@Osyotr
Copy link
Contributor

Osyotr commented Jul 30, 2024

https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests

The default message uses the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. You can also choose to use just the pull request title, the pull request title and commit details, >or the pull request title and description.<

I guess someone changed repository settings to this. Please change back to

pull request title and list of commits

@BillyONeal
Copy link
Member

The problem is in the commit message of the Squash Merge Commit which is synthetized from the initial post.

image

I think when you first complained about this I changed it to PR title instead.

@BillyONeal
Copy link
Member

I think this is 'the person clicking the merge button needs to do a better job' than something to complain about contributors about.

@BillyONeal
Copy link
Member

@FrankXie05 Thanks for looking in to this. I think the problem @dg0yt was talking about should be resolved now without needing to add more bots. Thanks!

@BillyONeal BillyONeal closed this Aug 2, 2024
@FrankXie05 FrankXie05 deleted the dev/Frank/37352 branch August 5, 2024 02:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:infrastructure Pertaining to the CI/Testing infrastrucutre info:internal This PR or Issue was filed by the vcpkg team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PR template clutters commit messages
5 participants