Maven S3 storage wagon

Upload/download maven artifacts using s3

The S3StorageWagon project enables you to upload your artifacts to a google cloud storage bucket.

<build>
    <extensions>
        <extension>
            <groupId>com.zextras.maven</groupId>
            <artifactId>s3storage</artifactId>
            <version>1.8</version>
        </extension>
    </extensions>
</build>

Full guide on wagon

Public repos

You can specify your artifacts to be public and thus getting downloaded without the need for authorised access to your bucket.

To specify a repo as public you can do it through the settings.xml

<server>
  <id>bucket-repo</id>
  <username>access_key</username>
  <password>access_secret</password>
  <configuration>
    <region>eu-west-1</region>
    <publicRepository>true</publicRepository>
  </configuration>
</server>

You can also use system properties with the mvn command

mvn deploy -DpublicRepository=true

Or through environmental variables

PUBLIC_REPOSITORY=true mvn deploy

Then you can use the artifact without any authorised access

    <repositories>
        <repository>
            <id>bucket-repo</id>
            <url>https://s3-eu-west-1.amazonaws.com/whatever/snapshot</url>
        </repository>
    </repositories>

Upload/download files for ci/cd purposes

Apart from giving a solution to use s3 a maven repository the storage s3storage can be used as a plugin in order to upload and download any items from s3.

Configuration

Note that the configuration set for servers and repositories does not apply to this mode of operation.

Authentication

Authentication must be passed by the environment. See the AWS S3 API documentation for a description of all locations where such configuration can be set.

A simple way to configure this is to define the username and password as Properties available to the maven environment:

<properties>
    <aws.accessKeyid>access_key</aws.accessKeyid>
    <aws.secretKey>access_secret</aws.secretKey>
</properties>

Alternatively, you may pick any of the other methods mentioned in the link above (e.g., defining the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables).

Upload files

<build>
    <plugins>
        <plugin>
            <groupId>com.zextras.maven</groupId>
            <artifactId>s3storage</artifactId>
            <version>1.5-SNAPSHOT</version>
            <executions>
                <execution>
                    <id>upload-single-file</id>
                    <phase>package</phase>
                    <goals>
                        <goal>s3-upload</goal>
                    </goals>
                    <configuration>
                        <bucket>yourbucketname</bucket>
                        <region>yourbucket-region</region>
                        <path>/file/path/test.txt</path>
                        <key>test.txt</key>
                    </configuration>
                </execution>
                <execution>
                    <id>upload-multiple-files</id>
                    <phase>package</phase>
                    <goals>
                        <goal>s3-upload</goal>
                    </goals>
                    <configuration>
                        <bucket>yourbucketname</bucket>
                        <region>yourbucket-region</region>
                        <path>/path/to/directory/with/files</path>
                        <key>prefixforfiles</key>
                    </configuration>
                </execution>
                <execution>
                    <id>upload-single-file-no-key</id>
                    <phase>package</phase>
                    <goals>
                        <goal>s3-upload</goal>
                    </goals>
                    <configuration>
                        <bucket>yourbucketname</bucket>
                        <region>yourbucket-region</region>
                        <path>/file/path/test.txt</path>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Download files

<build>
    <plugins>
        <plugin>
            <groupId>com.zextras.maven</groupId>
            <artifactId>s3storage</artifactId>
            <version>1.5-SNAPSHOT</version>
            <executions>
                <execution>
                    <id>download-multiple-files-to-one-directory</id>
                    <phase>package</phase>
                    <goals>
                        <goal>s3-download</goal>
                    </goals>
                    <configuration>
                        <bucket>yourbucketname</bucket>
                        <downloadPath>/path/to/directory</downloadPath>
                        <keys>file1.txt,file2.jpg</keys>
                    </configuration>
                </execution>
                <execution>
                    <id>download-files-and-files-starting-with-prefix</id>
                    <phase>package</phase>
                    <goals>
                        <goal>s3-download</goal>
                    </goals>
                    <configuration>
                        <bucket>yourbucketname</bucket>
                        <downloadPath>/path/to/directory</downloadPath>
                        <keys>prefix,file1.txt,file2.txt</keys>
                    </configuration>
                </execution>
                <execution>
                    <id>download-single-file</id>
                    <phase>package</phase>
                    <goals>
                        <goal>s3-download</goal>
                    </goals>
                    <configuration>
                        <bucket>yourbucketname</bucket>
                        <downloadPath>/path/to/directory/file.txt</downloadPath>
                        <keys>file-to-download.txt</keys>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Full guide on upload and download.