-
Notifications
You must be signed in to change notification settings - Fork 65.8k
Updated dependabot's docs to add Gradle Wrapper
#39954
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
base: main
Are you sure you want to change the base?
Conversation
|
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. |
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
@gmazzo Thanks for opening a PR! 🎉 It looks like this is still a draft. Could you ping me when this is ready? Then, I'll get it up for review ⚡ |
|
A stale label has been added to this pull request because it has been open 30 days with no activity. If you think this pull request should remain open, please add a new comment. |
|
This is still waiting for dependabot/dependabot-core#12891 |
|
I think that we may want to leave this as a draft as long as this is an experiment as it may cause confusion otherwise |
I was planning to move it to ready once the main PR is merged, and just let them decide when to merge this one. But I don't know how coordinated are dependabot and GH docs people 🤔 |
It is a mutual effort, but I don't think that folks here will be tracking things like feature flags before deciding when to merge. As per the plan, the goal is to enable globally in ~1 week if things go as planned. I'd suggest to not merge this yet to avoid confusions for non-beta-enabled users You've done wonderful work so far. I can help track when to enable it here 🚀 |
|
I also sent gmazzo#2 as another suggestion we can incorporate |
|
Is there anything still blocking this? |
kbukum1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
9e52473 to
c0f476a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds documentation for Gradle Wrapper support in Dependabot's supported package managers list. The change is related to a feature addition in the dependabot-core repository (PR #12891) that adds support for updating Gradle Wrapper versions.
Changes:
- Added
gradle/wrapper/gradle-wrapper.propertiesto the list of files that Dependabot supports for Gradle updates
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Clarified the terminology for the Gradle wrapper in the documentation.
debb323 to
9bd0c80
Compare
* Updated `dependabot`'s docs to add `Gradle Wrapper` * Explain the dependency name for the Gradle Wrapper * Reword --------- Co-authored-by: Guillermo Mazzola <gmazzo65@gmail.com>
* Updated `dependabot`'s docs to add `Gradle Wrapper` * Document that Gradle runs when updating the Gradle Wrapper * Remove empty line --------- Co-authored-by: Guillermo Mazzola <gmazzo65@gmail.com>
Hey @kbukum1 @schelombitko-bumble, just incorporated @yeikel suggestions. Since now it's 100% rolled out, I think we can move forward with this as well. |
|
@gmazzo , Updating the doc accordingly. |
Do you have any other feedback or can we ask the doc team for a second review round? |
We generally create internal doc and it is going through their review. I initiated the PR using copilot but currently it is having issue because pipelines are not working. When it is working I will check it if everything is ok, the doc team will review it. |
| * `gradlew` | ||
| * `gradlew.bat` | ||
| * `gradle/wrapper/gradle-wrapper.jar` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we can change it something like the following
{% data variables.product.prodname_dependabot %} supports updates to the following files without needing to run Gradle:
- `build.gradle`, `build.gradle.kts` (for Kotlin projects)
- `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog)
- `gradle.lockfile` (for projects using Gradle dependency locking)
- Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property).
{% data variables.product.prodname_dependabot %} runs Gradle to update the Gradle Wrapper:
- `gradle/wrapper/gradle-wrapper.properties`
- `gradlew`
- `gradlew.bat`
- `gradle/wrapper/gradle-wrapper.jar`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Feel free to craft any wording that fits better here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just added suggestion here. Let me know what do you think.
|
@gmazzo ,
Thanks @yeikel for the attention. @gmazzo , I am not sure but we have two sections that has duplicated. It may be better if we consolidate things around? Somehow I feel like we need to do make it in a way it is not repeating files. I understand both sections have different purpose but we may want to consolidate.
Sugggestion: I added suggestion in comment, https://github.com/github/docs/pull/39954/changes#r2756286217 Preview: Dependabot supports updates to the following files without needing to run Gradle:
Dependabot runs Gradle to update the Gradle Wrapper:
|
I'll let the doc part to you guys. I'm fine with any wording. |
| {% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to the following files: | ||
| * `build.gradle`, `build.gradle.kts` (for Kotlin projects) | ||
| * `gradle/wrapper/gradle-wrapper.properties` (for Gradle wrapper) | ||
| * `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog) | ||
| * `gradle.lockfile` (for projects using Gradle dependency locking) | ||
| * `gradle/wrapper/gradle-wrapper.properties` (for the Gradle Wrapper) | ||
| * Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property). | ||
|
|
||
| {% data variables.product.prodname_dependabot %} runs Gradle to update the Gradle Wrapper: | ||
| * `gradle/wrapper/gradle-wrapper.properties` | ||
| * `gradlew` | ||
| * `gradlew.bat` | ||
| * `gradle/wrapper/gradle-wrapper.jar` | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| {% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to the following files: | |
| * `build.gradle`, `build.gradle.kts` (for Kotlin projects) | |
| * `gradle/wrapper/gradle-wrapper.properties` (for Gradle wrapper) | |
| * `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog) | |
| * `gradle.lockfile` (for projects using Gradle dependency locking) | |
| * `gradle/wrapper/gradle-wrapper.properties` (for the Gradle Wrapper) | |
| * Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property). | |
| {% data variables.product.prodname_dependabot %} runs Gradle to update the Gradle Wrapper: | |
| * `gradle/wrapper/gradle-wrapper.properties` | |
| * `gradlew` | |
| * `gradlew.bat` | |
| * `gradle/wrapper/gradle-wrapper.jar` | |
| {% data variables.product.prodname_dependabot %} supports updates to the following files without needing to run Gradle: | |
| * `build.gradle`, `build.gradle.kts` (for Kotlin projects) | |
| * `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog) | |
| * `gradle.lockfile` (for projects using Gradle dependency locking) | |
| * Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property). | |
| {% data variables.product.prodname_dependabot %} runs Gradle to update the Gradle Wrapper: | |
| * `gradle/wrapper/gradle-wrapper.properties` | |
| * `gradlew` | |
| * `gradlew.bat` | |
| * `gradle/wrapper/gradle-wrapper.jar` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Thanks for the suggestions

Why:
dependabot/dependabot-core#12891 requires also to mention in the docs that now we'll support Gradle Wrapper in the
gradlemanagerCloses:
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following: