Skip to content

Latest commit

 

History

History
106 lines (84 loc) · 4.95 KB

README.md

File metadata and controls

106 lines (84 loc) · 4.95 KB
Raw

Maven GCP Storage Wagon Build Status Maven Central Coverage Status

Maven wagon provider for Google Cloud Storage. It allows publishing and downloading of artifacts from Google Cloud Storage bucket.

Usage

1. To allow the plugin to access the bucket configure access to the GCP by following instructions here. The easiest way to do so is by using IAM Service Accounts and configuring environment variable GOOGLE_APPLICATION_CREDENTIALS.

2. Configure the target project to use maven wagon for handling transport via pom.xml:

  <build>
      <extensions>
          <extension>
              <groupId>com.lahsivjar</groupId>
              <artifactId>gcp-storage-wagon</artifactId>
              <!-- Replace gcp.storage.wagon.version with the correct version -->
              <version>${gcp.storage.wagon.version}</version>
          </extension>
      </extensions>
  </build>

Maven loads parent pom before loading any wagon thus if the parent pom also relies on wagon plugin we have to use .mvn/extensions.xml file released in Maven 3.3.1 in the root of the target project. Example:

<?xml version="1.0" encoding="UTF-8"?>
<extensions>
    <extension>
        <groupId>com.lahsivjar</groupId>
        <artifactId>gcp-storage-wagon</artifactId>
        <!-- Replace gcp.storage.wagon.version with the correct version -->
        <version>${gcp.storage.wagon.version}</version>
    </extension>
</extensions>

3. Setup distribution management in the target project to deploy artifacts to:

  <distributionManagement>
      <snapshotRepository>
          <id>gcp-bucket-snapshot</id>
          <!-- Replace gcp.project-id and gcp.maven.bucket with correct values -->
          <url>gs://${gcp.project-id}#${gcp.maven.bucket}/snapshot</url>
      </snapshotRepository>
      <repository>
          <id>gcp-bucket-release</id>
          <!-- Replace gcp.project-id and gcp.maven.bucket with correct values -->
          <url>gs://${gcp.project-id}#${gcp.maven.bucket}/release</url>
      </repository>
  </distributionManagement>

NOTE: Check Project Id Resolution section to find all supported ways of resolving GCP project id.

4. To use the deployed modules in another project add extension as described in step 2 to the target project and specify a repository with the wagon configured:

  <repositories>
      <repository>
          <id>gcp-bucket-snapshot</id>
          <!-- Replace gcp.project-id and gcp.maven.bucket with correct values -->
          <url>gs://${gcp.project-id}#${gcp.maven.bucket}/snapshot</url>
      </repository>
      <repository>
          <id>gcp-bucket-release</id>
          <!-- Replace gcp.project-id and gcp.maven.bucket with correct values -->
          <url>gs://${gcp.project-id}#${gcp.maven.bucket}/release</url>
      </repository>
  </repositories>

NOTE: Check Project Id Resolution section to find all supported ways of resolving GCP project id.

GCP Project Id resolution

Project id of GCP can be resolved in the following two ways(in decreasing priority):

  1. By specifying it as part of the repository url. For example: gs://${gcp.project-id}#${gcp.maven.bucket}/
  2. By setting environment variable WAGON_GCP_PROJECT_ID. In this case the url must be of the form gs://${gcp.maven.bucket}/...

NOTE: It is priority based so if project id can be resolved via a higher priority resolver then the lower priority won't be considered

Environment variable interpolation

Hash based project id resolution scheme supports environment variable interpolation by specifying the repository url as gs://${env.GCP_PROJECT_ID}#${env.BUCKET_NAME} with GCP_PROJECT_ID and BUCKET_NAME exported as environment variables.

Issues

Report any issues or bugs to https://github.com/lahsivjar/gcp-storage-wagon/issues

Changelog

3.0

  • Update module to support Java 11

2.1

  • (Bugfix #19) Handle small files in single blob request

2.0

  • Environment variable interpolation for hash separated project id resolution

1.0

  • Add support for environment variable based project id resolution

0.1

  • Add basic wagon for GCP storage
  • Support resolving project id via the repository url

License

The project is licensed under Apache-2.0 - see the LICENSE file for details.