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

Dependabot yml commit-message prefs also impact PR titles #33995

Closed
1 task done
janbrasna opened this issue Jul 16, 2024 · 3 comments · Fixed by #34203
Closed
1 task done

Dependabot yml commit-message prefs also impact PR titles #33995

janbrasna opened this issue Jul 16, 2024 · 3 comments · Fixed by #34203
Labels
code security Content related to code security content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@janbrasna
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#commit-message

What part(s) of the article would you like to see updated?

The commit-message settings also impact PR titles — there's no mention in and around this config section (might be elsewhere, wasn't able to find it explained anywhere) so it'd be worth adding not only commits change, but also the effective PR titles.

Additionally there's no info how to change PR titles (= i.e. mention it's always populated based on the commit messages, either explicitly set or auto-detected from the repo history…)

Additional information

I wanted to change the format of Dependabot PR titles to pre-populate the correct form for squash merging and couldn't find any configuration for it. Only randomly found out the titles match the commits, therefore setting the commit-message pref also sets the PR title. This is not explained in the docs, and neither is a mention of how to change the format of the PR title for those who don't care about commit messages, but look for customising the PR titles. The setting does both (and is the only place for it.) = i.e. titles and commit messages are always to be set to the same style.

@janbrasna janbrasna added the content This issue or pull request belongs to the Docs Content team label Jul 16, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 16, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review code security Content related to code security and removed triage Do not begin working on this issue until triaged by the team labels Jul 17, 2024
@nguyenalex836
Copy link
Contributor

@janbrasna Thanks so much for opening an issue! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added the needs SME This proposal needs review from a subject matter expert label Jul 25, 2024
Copy link
Contributor

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@mchammer01 mchammer01 added the help wanted Anyone is welcome to open a pull request to fix this issue label Aug 5, 2024
@mchammer01
Copy link
Contributor

@janbrasna - Thanks for raising this ✨

I asked the Dependabot team about this and you are absolutely right. The commit prefix is added to the start of the PR title: https://github.com/dependabot/dependabot-core/blob/e8f477a63162bfcf5ad65d2e2155e54[…]/common/lib/dependabot/pull_request_creator/pr_name_prefixer.rb.

I'll add a help-wanted label so that anyone can raise a pull request to mention this in our docs, as well as information on how to change PR titles.

@mchammer01 mchammer01 removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code security Content related to code security content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants