diff --git a/docs/modules/modules/ROOT/pages/README.adoc b/docs/modules/modules/ROOT/pages/README.adoc index 2e23770d..52ce13a6 100644 --- a/docs/modules/modules/ROOT/pages/README.adoc +++ b/docs/modules/modules/ROOT/pages/README.adoc @@ -3,6 +3,7 @@ image::https://github.com/spring-cloud/spring-cloud-build/workflows/Build/badge. Spring Cloud Build is a common utility project for Spring Cloud to use for plugin and dependency management. +[[building-and-deploying]] == Building and Deploying To install locally: @@ -38,10 +39,12 @@ $ mvn deploy -P central -DaltReleaseDeploymentRepository=sonatype-nexus-staging: (the "central" profile is available for all projects in Spring Cloud and it sets up the gpg jar signing, and the repository has to be specified separately for this project because it is a parent of the starter parent which users in turn have as their own parent). +[[contributing]] == Contributing include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/docs/src/main/asciidoc/contributing.adoc[] +[[flattening-the-poms]] == Flattening the POMs To avoid propagating build setup that is required to build a Spring Cloud project, we're using the maven flatten plugin. It has the advantage of letting you use whatever features you need while publishing "clean" pom to the repository. @@ -60,6 +63,7 @@ In order to add it, add the `org.codehaus.mojo:flatten-maven-plugin` to your `po ---- +[[reusing-the-documentation]] == Reusing the documentation Spring Cloud Build publishes its `spring-cloud-build-docs` module that contains @@ -131,6 +135,7 @@ Spring Cloud Build Docs comes with a set of attributes for asciidoctor that you include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/main/pom.xml[tags=attributes,indent=0] ---- +[[updating-the-guides]] == Updating the guides We assume that your project contains guides under the `guides` folder. diff --git a/docs/modules/modules/ROOT/pages/building.adoc b/docs/modules/modules/ROOT/pages/building.adoc index 965e3858..964530eb 100644 --- a/docs/modules/modules/ROOT/pages/building.adoc +++ b/docs/modules/modules/ROOT/pages/building.adoc @@ -1,5 +1,6 @@ :jdkversion: 17 +[[basic-compile-and-test]] === Basic Compile and Test To build the source you will need to install JDK {jdkversion}. @@ -28,6 +29,7 @@ The projects that require middleware (i.e. Redis) for testing generally require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running. +[[documentation]] === Documentation The spring-cloud-build module has a "docs" profile, and if you switch @@ -39,6 +41,7 @@ parsing or rendering it, just copying it to `${main.basedir}` any changes in the README it will then show up after a Maven build as a modified file in the correct place. Just commit it and push the change. +[[working-with-the-code]] === Working with the code If you don't have an IDE preference we would recommend that you use https://www.springsource.com/developer/sts[Spring Tools Suite] or @@ -46,11 +49,13 @@ https://eclipse.org[Eclipse] when working with the code. We use the https://eclipse.org/m2e/[m2eclipse] eclipse plugin for maven support. Other IDEs and tools should also work without issue as long as they use Maven 3.3.3 or better. +[[activate-the-spring-maven-profile]] ==== Activate the Spring Maven profile Spring Cloud projects require the 'spring' Maven profile to be activated to resolve the spring milestone and snapshot repositories. Use your preferred IDE to set this profile to be active, or you may experience build errors. +[[importing-into-eclipse-with-m2eclipse]] ==== Importing into eclipse with m2eclipse We recommend the https://eclipse.org/m2e/[m2eclipse] eclipse plugin when working with eclipse. If you don't already have m2eclipse installed it is available from the "eclipse @@ -65,6 +70,7 @@ add the "spring" profile to your `settings.xml`. Alternatively you can copy the repository settings from the "spring" profile of the parent pom into your `settings.xml`. +[[importing-into-eclipse-without-m2eclipse]] ==== Importing into eclipse without m2eclipse If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command: diff --git a/docs/modules/modules/ROOT/pages/code-of-conduct.adoc b/docs/modules/modules/ROOT/pages/code-of-conduct.adoc index a83c3dc0..054553f7 100644 --- a/docs/modules/modules/ROOT/pages/code-of-conduct.adoc +++ b/docs/modules/modules/ROOT/pages/code-of-conduct.adoc @@ -1,4 +1,5 @@ +[[contributor-code-of-conduct]] = Contributor Code of Conduct As contributors and maintainers of this project, and in the interest of fostering an open @@ -42,4 +43,4 @@ with regard to the reporter of an incident. This Code of Conduct is adapted from the https://contributor-covenant.org[Contributor Covenant], version 1.3.0, available at -https://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/] \ No newline at end of file +https://contributor-covenant.org/version/1/3/0/[contributor-covenant.org/version/1/3/0/] diff --git a/docs/modules/modules/ROOT/pages/contributing-docs.adoc b/docs/modules/modules/ROOT/pages/contributing-docs.adoc index 0e219ced..395ad89b 100644 --- a/docs/modules/modules/ROOT/pages/contributing-docs.adoc +++ b/docs/modules/modules/ROOT/pages/contributing-docs.adoc @@ -1 +1 @@ -NOTE: Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at {github-project}[github]. \ No newline at end of file +NOTE: Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at {github-project}[github]. diff --git a/docs/modules/modules/ROOT/pages/contributing.adoc b/docs/modules/modules/ROOT/pages/contributing.adoc index 71f8aab5..ba0d14a7 100644 --- a/docs/modules/modules/ROOT/pages/contributing.adoc +++ b/docs/modules/modules/ROOT/pages/contributing.adoc @@ -6,6 +6,7 @@ tracker for issues and merging pull requests into master. If you want to contribute even something trivial please do not hesitate, but follow the guidelines below. +[[sign-the-contributor-license-agreement]] === Sign the Contributor License Agreement Before we accept a non-trivial patch or pull request we will need you to sign the https://cla.pivotal.io/sign/spring[Contributor License Agreement]. @@ -14,11 +15,13 @@ repository, but it does mean that we can accept your contributions, and you will author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests. +[[code-of-conduct]] === Code of Conduct This project adheres to the Contributor Covenant https://github.com/spring-cloud/spring-cloud-build/blob/master/docs/src/main/asciidoc/code-of-conduct.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. +[[code-conventions-and-housekeeping]] === Code Conventions and Housekeeping None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge. @@ -45,6 +48,7 @@ added after the original pull request but before a merge. if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit message (where XXXX is the issue number). +[[checkstyle]] === Checkstyle Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are: @@ -63,6 +67,7 @@ Spring Cloud Build comes with a set of checkstyle rules. You can find them in th <2> File header setup <3> Default suppression rules +[[checkstyle-configuration]] ==== Checkstyle configuration Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins. @@ -126,8 +131,10 @@ $ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/ $ touch .springformat ``` +[[ide-setup]] === IDE setup +[[intellij-idea]] ==== Intellij IDEA In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. @@ -178,10 +185,12 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources. +[[duplicate-finder]] === Duplicate Finder Spring Cloud Build brings along the `basepom:duplicate-finder-maven-plugin`, that enables flagging duplicate and conflicting classes and resources on the java classpath. +[[duplicate-finder-configuration]] ==== Duplicate Finder configuration Duplicate finder is *enabled by default* and will run in the `verify` phase of your Maven build, but it will only take effect in your project if you add the `duplicate-finder-maven-plugin` to the `build` section of the projecst's `pom.xml`. diff --git a/docs/modules/modules/ROOT/pages/spring-cloud-build.adoc b/docs/modules/modules/ROOT/pages/spring-cloud-build.adoc index ba98d967..9e36a4b0 100755 --- a/docs/modules/modules/ROOT/pages/spring-cloud-build.adoc +++ b/docs/modules/modules/ROOT/pages/spring-cloud-build.adoc @@ -1,3 +1,4 @@ +[[spring-cloud-build]] = Spring Cloud Build include::README.adoc[]