diff --git a/readme.md b/readme.md index 067db6339cb27495dbb0fabce25e5bb87de2668a..06de8a0e03d31357826825044c9402cbcf3a84e3 100644 --- a/readme.md +++ b/readme.md @@ -45,16 +45,12 @@ Generically, onboarding a project to Develocity consists of: The following sample shows a minimal Develocity configuration for a project building with Gradle 6 or above, using Groovy build scripts. A kotlin script sample (`setting.gradle.kts`) is available [here](https://github.com/gradle/develocity-build-config-samples/blob/main/common-develocity-gradle-configuration-kotlin/settings.gradle.kts). -> **Important!** if your project is hosted on github, replace `System.getenv("EF_SHORT_NAME")` or `env['EF_SHORT_NAME']` with the real short name of your project, e.g: `eclipse-mylyn-bot`. - #### settings.gradle -> **Important!** if your project is hosted on github, replace `System.getenv("EF_SHORT_NAME")` with the real short name of your project, e.g: `eclipse-mylyn-bot`. - ```groovy plugins { - id 'com.gradle.develocity' version '3.18.1' - id 'com.gradle.common-custom-user-data-gradle-plugin' version '2.0.2' + id 'com.gradle.develocity' version '3.19.1' + id 'com.gradle.common-custom-user-data-gradle-plugin' version '2.1' } def isCI = System.getenv('CI') != null // adjust to your CI provider @@ -72,13 +68,13 @@ develocity { } buildCache { - // disable local caching in CI, unless already used by the build + // disable local caching in CI, unless already used by the build on CI local { enabled = !isCI } // disable remote caching, unless already used by the build or you want to use / experiment with it remote(develocity.buildCache) { - enabled = false + enabled = true push = isCI } } @@ -103,7 +99,7 @@ The following sample shows a Develocity configuration for a Maven project: <extension> <groupId>com.gradle</groupId> <artifactId>develocity-maven-extension</artifactId> - <version>1.22.2</version> + <version>1.23.1</version> </extension> <extension> <groupId>com.gradle</groupId> @@ -115,8 +111,6 @@ The following sample shows a Develocity configuration for a Maven project: #### .mvn/develocity.xml -> **Important!** if your project is hosted on github, replace `env['EF_SHORT_NAME']` with the real short name of your project, e.g: `eclipse-mylyn-bot`. - ```xml <?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <develocity @@ -139,10 +133,10 @@ The following sample shows a Develocity configuration for a Maven project: </buildScan> <buildCache> <local> - <enabled>#{isFalse(env['CI'])}</enabled> + <enabled>false</enabled> <!-- Set to true if you want to use / experiment with local caching. Alternatively you can also use #{isFalse(env['CI'])} --> </local> <remote> - <enabled>false</enabled> + <enabled>false</enabled> <!-- Set to true if you want to use / experiment with remote caching --> <storeEnabled>#{isTrue(env['CI'])}</storeEnabled> <!-- adjust to your CI provider --> </remote> </buildCache> @@ -172,6 +166,10 @@ https://docs.gradle.com/develocity/get-started/#integrating_your_ci_tool #### Jenkins +> **Important:** The CI integration needs to be completed by the Eclipse Foundation IT team **before** the following configuration can be used. You can request it by filling a ticket on the [helpdesk](https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/new). + +> **Note:** The <project_id> should be taken from the [project.eclipse.org](http://project.eclipse.org/), for example https://projects.eclipse.org/projects/technology.escet -> `technology.escet` and not from [ci.eclipse.org](http://ci.eclipse.org/) path. + ```groovy def secrets = [ [path: 'cbi/<project_id>/develocity.eclipse.org', secretValues: [ @@ -190,7 +188,7 @@ pipeline { stage('Build') { steps { withVault([vaultSecrets: secrets]) { - sh 'mvn clean verify -Prelease -B' + sh 'mvn clean install' } } } @@ -366,6 +364,8 @@ doc: https://docs.gradle.com/develocity/maven-extension/current/#obfuscating_ide #### Tags +> **Note:** commonly added tags and other custom data (links, values) are added by the [Common Custom User Data Gradle Plugin](https://github.com/gradle/common-custom-user-data-gradle-plugin) or the [Common Custom User Data Maven Extension](https://github.com/gradle/common-custom-user-data-maven-extension). + 1. Gradle: `build.gradle.kts` doc: https://docs.gradle.com/develocity/gradle-plugin/current/#adding_tags