GoogleCloudPlatform / java-repo-tools

Tools used to maintain and test Java repositories in the GoogleCloudPlatform organization.
Apache License 2.0
27 stars 39 forks source link

Safe to remove this when using a sample project? #60

Closed Orbyt closed 7 years ago

Orbyt commented 7 years ago

I used one of the GAE quickstarts to quickly get some boilerplate files for my project. I noticed that builds were failing due to a checkstyle plugin, and after investigation ended up here.

It looks like the checkstyle plugin is added in if the following code from the quickstart is left in:

<parent>
    <groupId>com.google.cloud.samples</groupId>
    <artifactId>shared-configuration</artifactId>
    <version>1.0.1</version>
   </parent>

Is it safe to remove this? I understand removing it will get rid of the checkstyle plugin, which is desired, however I am unsure what other dependencies might be removed, and don't want to remove something that is critical.

tswast commented 7 years ago

This package should not include any shared dependencies, only plugins for testing/version updates/checkstyle. It should be safe to remove from any sample you see on Google Cloud Platform.

If a sample does not work after removing the parent, please file an issue on the repo where the sample is hosted.

P.S. I'd very much like to add the parent in our samples only at test time to make this clearer, but I haven't gotten around to it, yet.

Orbyt commented 7 years ago

@tswast Thank you, i'll go ahead and close this then.