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.

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

Backport: Rewrite Build Lifecycle documentation in a consistent docs voice #23577

Merged
merged 26 commits into from Jan 20, 2023
Merged

Backport: Rewrite Build Lifecycle documentation in a consistent docs voice #23577

merged 26 commits into from Jan 20, 2023

Conversation

FrauBoes
Copy link
Contributor

@FrauBoes FrauBoes commented Jan 18, 2023 •
edited

Context

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

Gradle Core Team Checklist

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation

Rewrite Build Lifecycle documentation in a consistent docs voice
b6cfefe 
(cherry picked from commit c08c821)
Signed-off-by: Julia Boes <jboes@gradle.com>
@FrauBoes FrauBoes self-assigned this Jan 18, 2023
@bot-gradle bot-gradle added this to the 7.6.1 milestone Jan 18, 2023
@FrauBoes FrauBoes added the a:documentation Documentation content label Jan 18, 2023
Fix links broken during refactor
d7abd5c 
(cherry picked from commit bfbb6c4)
Signed-off-by: Julia Boes <jboes@gradle.com>
@gradle gradle deleted a comment from FrauBoes Jan 19, 2023
@gradle gradle deleted a comment from FrauBoes Jan 19, 2023
@FrauBoes FrauBoes requested a review from a team January 19, 2023 10:37
nathan-contino and others added 21 commits January 19, 2023 13:57
@nathan-contino @eskatos
Clarify that plugins also configure the dependency graph.
7f59776 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit d38d458)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Tighten up description of execution phase
039e5e6 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit e27e946)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Add included builds mention to build lifecycle explanation
e13524e 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit 137184f)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Add included builds to another section of the build lifecycle doc
80542c3 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit ba2d99c)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Add composite builds mention in lifecycle docs
b1b79bb 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit b99a3af)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Change create to register, clarify configuration actions
8ef6057 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit ffe2a3c)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Replace Project.afterEvaluate with gradle.afterProject
a769dfe 
(cherry picked from commit 7530fc7)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Make it clearer that you should always define a settings file
ac93d0d 
(cherry picked from commit 842006d)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Clarify settings file evaluation order
3eb95d6 
(cherry picked from commit dc2618d)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Included Kotlin and Groovy DSL settings file variants
b4b6c18 
(cherry picked from commit dc6131b)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Link to settings file documentation on first occurrence
31daead 
(cherry picked from commit 0229876)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Clarify that task graph applies to requested tasks only
d568062 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit ed34216)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Inclusivity for Kotlin AND Groovy DSLs
1caab0d 
(cherry picked from commit 87f2015)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Include Kotlin and Groovy DSL
2a393c9 
(cherry picked from commit c224b27)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino @eskatos
Clarify that task execution graph only includes requested tasks
e77611d 
Co-authored-by: Paul Merlin <paul@nosphere.org>
(cherry picked from commit e8e6eca)
Signed-off-by: Julia Boes <jboes@gradle.com>
Remove allproject antipattern and eliminate now-redundant afterProjec…
fb06945 
…t example

(cherry picked from commit 29a4758)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Update subprojects/docs/src/docs/userguide/authoring-builds/build_lif…
4e3fe3f 
…ecycle.adoc

(cherry picked from commit 55af8ed)
Signed-off-by: Julia Boes <jboes@gradle.com>
Switch example to ExtraProperties
1a661ef 
(cherry picked from commit e21a89a)
Signed-off-by: Julia Boes <jboes@gradle.com>
Make project closure arg explicit
99e3bf9 
(cherry picked from commit 2c24e03)
Signed-off-by: Julia Boes <jboes@gradle.com>
Remove explicit project arg from kotlin
e562276 
(cherry picked from commit 9b79e54)
Signed-off-by: Julia Boes <jboes@gradle.com>
Fix type inference failure
9404ac1 
(cherry picked from commit cf0b0d4)
Signed-off-by: Julia Boes <jboes@gradle.com>
@nathan-contino
Update subprojects/docs/src/docs/userguide/authoring-builds/build_lif…
1e69399 
…ecycle.adoc

(cherry picked from commit 0c7c1a5)
Signed-off-by: Julia Boes <jboes@gradle.com>
@gradle gradle deleted a comment from FrauBoes Jan 19, 2023
@FrauBoes
Copy link
Contributor Author

@bot-gradle test and merge

@gradle gradle deleted a comment from FrauBoes Jan 20, 2023
@bot-gradle
Copy link
Collaborator

I've triggered a build for you.

@FrauBoes
Copy link
Contributor Author

@bot-gradle test and merge

@gradle gradle deleted a comment from FrauBoes Jan 20, 2023
@bot-gradle
Copy link
Collaborator

Your PR is queued. See the queue page for details.

@bot-gradle
Copy link
Collaborator

Pre-tested commit build failed.

@bot-gradle
Copy link
Collaborator

I've triggered a build for you.

@bot-gradle bot-gradle merged commit 365c6a2 into release7x Jan 20, 2023
@bot-gradle bot-gradle deleted the frauboes/docs/build-lifecycle branch January 20, 2023 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eskatos eskatos eskatos approved these changes

Assignees

@FrauBoes FrauBoes

Labels
a:documentation Documentation content
Projects
None yet
Milestone
7.6.1
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@FrauBoes @bot-gradle @eskatos @nathan-contino