From f49aae622242ddad7de86449841a61cee2aca535 Mon Sep 17 00:00:00 2001 From: Martijn Verburg Date: Sun, 1 Dec 2019 11:37:24 +0000 Subject: [PATCH 1/3] Add workaround for Checkstyle error, closes #6216 Signed-off-by: Martijn Verburg --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a24d4f359cda..a71a2c52bcf0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,6 +77,19 @@ mvn -f sdk/{projectForlderDir}/pom.xml -Dgpg.skip clean install //example: mvn -f sdk/keyvault/azure-security-keyvault-keys/pom.xml clean install ``` +### Workaround for Checkstyle error + +You may run across an error on checkstyle, something like: + +``` +Failed to load suppressions file from: ./maven-java-parent/java-8-parent/target/checkstyle-suppressions.xml: +Unable to find: ./maven-java-parent/java-8-parent/target/checkstyle-suppressions.xml: +http://www.puppycrawl.com/dtds/suppressions_1_0.dtd +``` + +This is because the `sdk-build-tools` project doesn't currently get released to Maven. To install it you'll need to have the `eng` folder copied locally and then run: +`mvn clean install eng/code-quality-reports/pom.xml`. + ## Versions and versioning Tooling has been introduced to centralize versioning and help ease the pain of updating artifact versions in POM and README files. Under the eng\versioning directory there exists version text files, one for client ([version_client.txt](./eng/versioning/version_client.txt)) and one for data ([version_data.txt](./eng/versioning/version_data.txt)). The format of the version files is as follows: From a3043111a6631861f69bc1e4e7fbd8630ba84c0e Mon Sep 17 00:00:00 2001 From: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> Date: Thu, 9 Jul 2020 12:33:27 -0700 Subject: [PATCH 2/3] Update CONTRIBUTING.md Updates to workaround section. --- CONTRIBUTING.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a71a2c52bcf0..399be8bc889e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,16 +79,19 @@ mvn -f sdk/{projectForlderDir}/pom.xml -Dgpg.skip clean install ### Workaround for Checkstyle error -You may run across an error on checkstyle, something like: +When building locally you might run into a Checkstyle such as the following: ``` -Failed to load suppressions file from: ./maven-java-parent/java-8-parent/target/checkstyle-suppressions.xml: -Unable to find: ./maven-java-parent/java-8-parent/target/checkstyle-suppressions.xml: -http://www.puppycrawl.com/dtds/suppressions_1_0.dtd +Execution default of goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check failed: +Plugin org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0 or one of its dependencies could not be resolved: +Could not find artifact com.azure:sdk-build-tools:jar:1.0.0 in ossrh (https://oss.sonatype.org/content/repositories/snapshots/) ``` -This is because the `sdk-build-tools` project doesn't currently get released to Maven. To install it you'll need to have the `eng` folder copied locally and then run: -`mvn clean install eng/code-quality-reports/pom.xml`. +This is because the `sdk-build-tools` project isn't released to Maven. To resolve this issue you'll need to copy the `eng` folder locally then install `sdk-build-tools`. + +`mvn clean install eng/code-quality-reports/pom.xml` + +All code in the Azure SDKs for Java repository must pass Checkstyle before being merged. The `azure-sdk-tools` is updated periodically, so if a new branch fails Checkstyle you'll need to reinstall `sdk-build-tools`. ## Versions and versioning From 5cf590d91923d5b53feb88ff88a664b8813f35a3 Mon Sep 17 00:00:00 2001 From: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> Date: Thu, 9 Jul 2020 12:48:16 -0700 Subject: [PATCH 3/3] Update CONTRIBUTING.md Minor fix to use correct reference --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d892f0541274..80be7a0bc41e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,7 +101,7 @@ This is because the `sdk-build-tools` project isn't released to Maven. To resolv `mvn clean install eng/code-quality-reports/pom.xml` -All code in the Azure SDKs for Java repository must pass Checkstyle before being merged. The `azure-sdk-tools` is updated periodically, so if a new branch fails Checkstyle you'll need to reinstall `sdk-build-tools`. +All code in the Azure SDKs for Java repository must pass Checkstyle before being merged. The `sdk-build-tools` is updated periodically, so if a new branch fails Checkstyle you'll need to reinstall. ## Versions and versioning