Document behavior of prefix in dependabot.yml#22884
Conversation
It would have been helpful to me if the documentation was more straight-forward about that a `:` is appended to the commit title by default and how to disable that the `:` is appended. For reference, here is the implementation: https://github.com/dependabot/dependabot-core/blob/06702c83e5d964173504ddba6838c37fe37207ba/common/lib/dependabot/pull_request_creator/pr_name_prefixer.rb#L75-L83
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
|
@schra Thanks so much for opening a PR! I'll get this triaged for review ⚡ |
|
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
|
Hi @schra - thanks for raising this issue ✨ |
There was a problem hiding this comment.
@schra - thanks for creating this PR to document the behavior of prefix ✨
I haven't been able to commit a change I'd like to make to line 251. As well as providing users with the example you've updated, I'd like us to explicitly document the behavior. Can you add the following to that line, after prefix specifies a prefix for all commit messages.?
When you specify a prefix for commit messages, {% data variables.product.prodname_dotcom %} will automatically add a colon between the defined prefix and the commit message, unless you end the end the prefix with a space. The code snippet below provides examples of both in the same configuration file.
Thank you 😃
Feel free to ping me when you're done. I'll review again and will ask an engineer from the Dependabot Updates team to give this a quick technical review, before we merge this 🙇🏻
…nfiguration-options-for-the-dependabot.yml-file.md
…nfiguration-options-for-the-dependabot.yml-file.md
…nfiguration-options-for-the-dependabot.yml-file.md Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
mchammer01
left a comment
There was a problem hiding this comment.
@schra - This LGTM ![]()
Thanks for your patience, and for working with me on this contribution ✨
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
|
Awesome, thanks for merging and your input @mchammer01 :) |
Why:
It would have been helpful to me if the documentation was more straight-forward about that a
:is appended to the commit title by default and how to disable that the:is appended (for example, by having trailing whitespace)For reference, here is the implementation:
https://github.com/dependabot/dependabot-core/blob/06702c83e5d964173504ddba6838c37fe37207ba/common/lib/dependabot/pull_request_creator/pr_name_prefixer.rb#L75-L83
What's being changed (if available, include any code snippets, screenshots, or gifs):
Add an example, how to disable that a
:is appended.Check off the following: