Skip to content

Document behavior of prefix in dependabot.yml#22884

Merged
mchammer01 merged 10 commits intogithub:mainfrom
schra:feat/document-dependabot-prefix
Jan 19, 2023
Merged

Document behavior of prefix in dependabot.yml#22884
mchammer01 merged 10 commits intogithub:mainfrom
schra:feat/document-dependabot-prefix

Conversation

@schra
Copy link
Copy Markdown
Contributor

@schra schra commented Dec 28, 2022

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:

  • 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).
  • For content changes, I have completed the self-review checklist.

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
@welcome
Copy link
Copy Markdown

welcome Bot commented Dec 28, 2022

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.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Dec 28, 2022
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 28, 2022

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

@cmwilson21
Copy link
Copy Markdown
Contributor

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

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team dependabot Content related to Dependabot code security Content related to code security waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Dec 28, 2022
@mchammer01 mchammer01 added the needs SME This proposal needs review from a subject matter expert label Jan 9, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 9, 2023

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

@mchammer01
Copy link
Copy Markdown
Contributor

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 mchammer01 self-requested a review January 9, 2023 12:02
Copy link
Copy Markdown
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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 🙇🏻

Beloved11

This comment was marked as spam.

@cmwilson21 cmwilson21 added the more-information-needed More information is needed to complete review label Jan 10, 2023
@schra schra requested a review from mchammer01 January 10, 2023 22:41
@cmwilson21 cmwilson21 removed the more-information-needed More information is needed to complete review label Jan 11, 2023
…nfiguration-options-for-the-dependabot.yml-file.md

Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
@schra schra requested a review from mchammer01 January 17, 2023 22:31
Copy link
Copy Markdown
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@schra - This LGTM :shipit:
Thanks for your patience, and for working with me on this contribution ✨

@mchammer01 mchammer01 enabled auto-merge January 19, 2023 08:30
@mchammer01 mchammer01 merged commit c7743c5 into github:main Jan 19, 2023
@github-actions
Copy link
Copy Markdown
Contributor

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

@schra
Copy link
Copy Markdown
Contributor Author

schra commented Jan 19, 2023

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

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 dependabot Content related to Dependabot needs SME This proposal needs review from a subject matter expert waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants