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

proposal: add custom commit message example (s) #18302

Merged
merged 5 commits into from
Jun 10, 2022
Merged

Conversation

fuadop
Copy link
Contributor

@fuadop fuadop commented May 28, 2022

Why:

This is related to dependabot/dependabot-core#5192 .

cc: @jeffwidman

Closes [https://github.com/dependabot/dependabot-core/issues/5192 ]

What's being changed:

Check off the following:

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

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented May 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 May 28, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 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.5 3.4 3.3
fpt
ghec
ghes@ 3.5 3.4 3.3

Copy link
Member

@jeffwidman jeffwidman left a comment

Choose a reason for hiding this comment

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

Thanks for putting up the PR! We always appreciate improvements to the docs.

…nfiguration-options-for-the-dependabot.yml-file.md

Co-authored-by: Jeff Widman <jeff@jeffwidman.com>
@cmwilson21
Copy link
Contributor

@fuadop 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 waiting for review Issue/PR is waiting for a writer's review dependabot Content related to Dependabot and removed triage Do not begin working on this issue until triaged by the team labels May 31, 2022
@mchammer01 mchammer01 self-requested a review June 10, 2022 10:12
mchammer01
mchammer01 previously approved these changes Jun 10, 2022
Copy link
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.

@fuadop 👋🏻 - LGTM ✨
I've made a few minor comments, mainly to do with formatting and content models in our docs. Will apply the suggestions and then hopefully merge this PR.
Thank you for contributing to improve out docs ⚡

@mchammer01 mchammer01 added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Jun 10, 2022
@mchammer01 mchammer01 merged commit 00c3e32 into github:main Jun 10, 2022
@github-actions
Copy link
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

@fuadop
Copy link
Contributor Author

fuadop commented Jun 10, 2022

Thanks @mchammer01 @cmwilson21 @jeffwidman for your help on this 🎉❤️.

@tobiasdiez
Copy link

I'm confused by this remark in the docs and went to the code to understand the behavior. The commit message prefix is determined in (if I'm not mistaken):
https://github.com/dependabot/dependabot-core/blob/c00613fdce7f13eb832d5cd5ae9f0ac116edb50c/common/lib/dependabot/pull_request_creator/pr_name_prefixer.rb#L74-L82

If I'm reading this correctly, then with

commit-message:
      prefix: "pip prod"
      prefix-development: "pip dev"
      include: "scope"

the prefix would be:

  • for production deps: pip prod(deps)
  • for dev deps: pip dev(deps-dev)

Can someone please clarify this. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team dependabot Content related to Dependabot ready to merge This pull request is ready to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants