Skip to content

Add Best Practice: Declare Repositories in Settings #32882

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 17, 2025
Merged

Add Best Practice: Declare Repositories in Settings #32882

merged 2 commits into from
Apr 17, 2025

Conversation

liutikas
Copy link
Collaborator

Tested with ./gradlew serveDocs -PquickDocs and looking at http://127.0.0.1:8000/userguide/bp_dependencies.html

Ran snippet tests with:
./gradlew :docs:docsTest --tests "snippet-best-practices-settings-repositories-do"
./gradlew :docs:docsTest --tests "snippet-best-practices-settings-repositories-dont"

Context

Adding a best practice for setting up respositories

Contributor Checklist

  • Review Contribution Guidelines.
  • Make sure that all commits are signed off to indicate that you agree to the terms of Developer Certificate of Origin.
  • Make sure all contributed code can be distributed under the terms of the Apache License 2.0, e.g. the code was written by yourself or the original code is licensed under a license compatible to Apache License 2.0.
  • Check "Allow edit from maintainers" option in pull request so that additional changes can be pushed by Gradle team.
  • Provide integration tests (under <subproject>/src/integTest) to verify changes from a user perspective.
  • Provide unit tests (under <subproject>/src/test) to verify logic.
  • Update User Guide, DSL Reference, and Javadoc for public-facing changes.
  • Ensure that tests pass sanity check: ./gradlew sanityCheck.
  • Ensure that tests pass locally: ./gradlew <changed-subproject>:quickTest.

Reviewing cheatsheet

Before merging the PR, comments starting with

  • ❌ ❓must be fixed
  • 🤔 💅 should be fixed
  • 💭 may be fixed
  • 🎉 celebrate happy things

@liutikas liutikas requested a review from a team as a code owner March 28, 2025 20:14
@liutikas liutikas requested review from a team March 28, 2025 20:14
@bot-gradle bot-gradle added from:contributor PR by an external contributor to-triage labels Mar 28, 2025
@liutikas liutikas changed the base branch from master to release March 28, 2025 20:14
@mlopatkin mlopatkin removed the request for review from a team March 28, 2025 20:41
@ljacomet ljacomet added a:documentation Documentation content in:tutorial and removed to-triage labels Mar 31, 2025
@ljacomet
Copy link
Member

Thank you for your contribution!

The DCO check is failing, please look into that as we can't accept the PR otherwise.

@ljacomet ljacomet added to-triage pending:dco PR DCO check is failing, commits need to be signed off labels Mar 31, 2025
@liutikas liutikas force-pushed the repositoriesbestpractice branch from 50abc02 to baa15fb Compare March 31, 2025 15:46
@liutikas
Copy link
Collaborator Author

The DCO check is failing, please look into that as we can't accept the PR otherwise.

Done

@github-actions github-actions bot removed the pending:dco PR DCO check is failing, commits need to be signed off label Mar 31, 2025
@tresat tresat added the re:footguns-and-best-practices Issues related to avoiding pitfalls in Gradle label Mar 31, 2025
@tresat tresat self-assigned this Mar 31, 2025
@tresat tresat added this to the 8.14 RC1 milestone Mar 31, 2025
tresat
tresat requested changes Mar 31, 2025
View reviewed changes
@liutikas liutikas requested a review from tresat March 31, 2025 23:02
@liutikas liutikas added re:footguns-and-best-practices Issues related to avoiding pitfalls in Gradle and removed re:footguns-and-best-practices Issues related to avoiding pitfalls in Gradle labels Apr 1, 2025
@liutikas liutikas requested a review from big-guy April 4, 2025 15:08
@lkasso lkasso changed the title Add a best practice for declaring repositories in settings Add Best Practice: Declare Repositories in Settings Apr 7, 2025
@lkasso lkasso assigned liutikas and unassigned tresat Apr 7, 2025
lkasso
lkasso reviewed Apr 7, 2025
View reviewed changes
@liutikas liutikas force-pushed the repositoriesbestpractice branch 2 times, most recently from b7a9b67 to 162a2c2 Compare April 11, 2025 15:19
@tresat
Copy link
Member

tresat commented Apr 11, 2025

@bot-gradle test and merge

@bot-gradle bot-gradle added this pull request to the merge queue Apr 11, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 11, 2025
@tresat
Copy link
Member

tresat commented Apr 11, 2025 

> Task :docs:checkDeadInternalLinks FAILED
ERROR: bp_dependencies.adoc:54 Looking for section named tag:structuring-builds in tags_reference.adoc
    `<<tags_reference.adoc#tag:structuring-builds,#structuring-builds>>`

Run that task, fix the links and make sure it succeeds, then I'll try merging again.

@liutikas liutikas force-pushed the repositoriesbestpractice branch from 162a2c2 to fc6f015 Compare April 15, 2025 16:08
@liutikas
Copy link
Collaborator Author 

> Task :docs:checkDeadInternalLinks FAILED
ERROR: bp_dependencies.adoc:54 Looking for section named tag:structuring-builds in tags_reference.adoc
    `<<tags_reference.adoc#tag:structuring-builds,#structuring-builds>>`

Run that task, fix the links and make sure it succeeds, then I'll try merging again.

Rebased on top of your change. Please rerun merge.

@liutikas liutikas closed this Apr 15, 2025
@liutikas liutikas reopened this Apr 15, 2025
@liutikas
Add a best practice for declaring repositories in settings
c2cb837 
Tested with ./gradlew serveDocs -PquickDocs and looking at http://127.0.0.1:8000/userguide/bp_dependencies.html

Ran snippet tests with:
./gradlew :docs:docsTest --tests "snippet-best-practices-settings-repositories-do"
./gradlew :docs:docsTest --tests "snippet-best-practices-settings-repositories-dont"

Signed-off-by: Aurimas Liutikas <[email protected]>
@liutikas liutikas force-pushed the repositoriesbestpractice branch from fc6f015 to c2cb837 Compare April 15, 2025 16:13
@tresat
Copy link
Member

tresat commented Apr 15, 2025

@bot-gradle test and merge

@bot-gradle bot-gradle added this pull request to the merge queue Apr 15, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 15, 2025
@blindpirate
Copy link
Collaborator

Failures:

@tresat
Copy link
Member

tresat commented Apr 16, 2025

@bot-gradle test and merge

@bot-gradle bot-gradle added this pull request to the merge queue Apr 16, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 16, 2025
@ljacomet ljacomet modified the milestones: 8.14 RC2, 8.14 Apr 17, 2025
@blindpirate blindpirate requested a review from a team as a code owner April 17, 2025 12:30
@blindpirate blindpirate enabled auto-merge April 17, 2025 12:30
@blindpirate blindpirate added this pull request to the merge queue Apr 17, 2025
Merged via the queue into gradle:release with commit 214c09b Apr 17, 2025
5 checks passed
@ljacomet ljacomet modified the milestones: 8.14, 8.14 RC3 Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tresat tresat tresat approved these changes

@lkasso lkasso lkasso approved these changes

@big-guy big-guy Awaiting requested review from big-guy

Assignees

@liutikas liutikas

Labels

a:documentation Documentation content from:contributor PR by an external contributor re:footguns-and-best-practices Issues related to avoiding pitfalls in Gradle

Projects

None yet

Milestone

8.14 RC3

Development

Successfully merging this pull request may close these issues.

7 participants

@liutikas @ljacomet @tresat @blindpirate @lkasso @cobexer @bot-gradle