docs icon indicating copy to clipboard operation
docs copied to clipboard

Document behavior of `prefix` in dependabot.yml

Open schra opened this issue 3 years ago • 3 comments

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:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

schra avatar Dec 28 '22 12:12 schra

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.

welcome[bot] avatar Dec 28 '22 12:12 welcome[bot]

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Preview Production What Changed
code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md fpt
ghec
ghes@ 3.7 3.6 3.5 3.4 3.3
fpt
ghec
ghes@ 3.7 3.6 3.5 3.4 3.3

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Dec 28 '22 13:12 github-actions[bot]

@schra Thanks so much for opening a PR! I'll get this triaged for review :zap:

cmwilson21 avatar Dec 28 '22 14:12 cmwilson21

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Jan 09 '23 11:01 github-actions[bot]

Hi @schra - thanks for raising this issue ✨ I am going to liaise with the Dependabot Updates team and will come back to you once I've heard from them. Thanks for your patience 💖

mchammer01 avatar Jan 09 '23 11:01 mchammer01

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 :zap:

github-actions[bot] avatar Jan 19 '23 08:01 github-actions[bot]

Awesome, thanks for merging and your input @mchammer01 :)

schra avatar Jan 19 '23 23:01 schra