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

Document the Gradle build configuration #11568

Open
Tracked by #11230
nathanklick opened this issue Feb 15, 2024 · 3 comments
Open
Tracked by #11230

Document the Gradle build configuration #11568

nathanklick opened this issue Feb 15, 2024 · 3 comments
Assignees

Comments

@nathanklick
Copy link
Member

nathanklick commented Feb 15, 2024

Description

The Gradle build logic needs to be documented including:

  • The build-logic folder
  • Project/module naming standards
  • Use of the GradleX tooling
  • Available custom tasks
@jjohannes
Copy link
Collaborator

As part of this (or split-out into separate issue): Use unified naming and structure in all repositories

For example:

  • Use gradle/plugins as "build logic" folder everywhere
  • Use com.hedera.gradlebuild... as namespace for all convention plugin
  • Use similar naming for plugins that do similar things in the different repos
  • Use the exact same names for convention plugins that do exactly the same in different repos (later we could think about sharing the logic between repos)

@jjohannes
Copy link
Collaborator

jjohannes commented Apr 4, 2024

Start with the user documentation

As part of this, move the following to docs folder in root, update where appropriate. Make sure we have a full "how and what to use Gradle for in daily development" guide.

  • branch-naming-conventions
  • docker-quickstart <-- this is services specific, generally no docker is needed for development
  • gradle-quickstart
  • hedera-java-style-guide
  • intellij-quickstart
  • maintainers-guide

@jjohannes
Copy link
Collaborator

I plan to document the Gradle setup itself in the README of the new repository we'll create for the Gradle setup as part of #14255

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants