Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/michaelboyles/s3-maven-extension

Maven wagon transport for Amazon S3
https://github.com/michaelboyles/s3-maven-extension

maven s3

Last synced: 1 day ago
JSON representation

Maven wagon transport for Amazon S3

Host: GitHub
URL: https://github.com/michaelboyles/s3-maven-extension
Owner: michaelboyles
License: mit
Created: 2024-06-07T11:16:45.000Z (5 months ago)
Default Branch: develop
Last Pushed: 2024-08-13T18:04:40.000Z (3 months ago)
Last Synced: 2024-08-13T21:14:25.638Z (3 months ago)
Topics: maven, s3
Language: Java
Homepage:
Size: 33.2 KB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/michaelboyles/s3-maven-extension/build.yml?branch=develop)](https://github.com/michaelboyles/s3-maven-extension/actions)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/michaelboyles/s3-maven-extension?sort=semver)](https://github.com/michaelboyles/s3-maven-extension/releases)

[![GitHub](https://img.shields.io/github/license/michaelboyles/s3-maven-extension)](https://github.com/michaelboyles/s3-maven-extension/blob/develop/LICENSE)

This [Maven extension](https://maven.apache.org/guides/mini/guide-using-extensions.html) provides support for

Amazon [S3](https://aws.amazon.com/s3/), instead of an artifact repository (e.g. Artifactory, Sonatype Nexus). It provides

a ["wagon"](https://maven.apache.org/wagon/) (a transport abstraction) which lets you use the URL scheme `s3://` where

you'd usually use `https://`.

## Usage

Add the extension to the `` section of your POM, e.g.

```xml

   

      io.github.michaelboyles

      s3-maven-extension

      0.5.0

   

```

Specify the region of your S3 bucket using one of the following methods, listed with highest precedence first. This uses

[the default AWS SDK logic](https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/regions/providers/DefaultAwsRegionProviderChain.html):

1. `aws.region` system property, i.e. `-Daws.region=my-region`

2. `AWS_REGION` environment variable

3. `{user.home}/.aws/credentials` and `{user.home}/.aws/config` files

4. Container metadata (e.g. EC2)

Specify your credentials using one of the following methods, listed with highest precedence first.

1. `aws.accessKeyId`, `aws.secretAccessKey` and (optionally) `aws.sessionToken` [system properties](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/SystemPropertyCredentialsProvider.html),

   e.g. `-Daws.accessKeyId=my-key`

2. `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and (optionally) `AWS_SESSION_TOKEN` [environment variables](https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/auth/credentials/EnvironmentVariableCredentialsProvider.html) 

3. [Web identity token file](https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/auth/credentials/WebIdentityTokenFileCredentialsProvider.html)

4. The server 'username' and 'password' fields from Maven [settings.xml](https://maven.apache.org/settings.html#servers), where username is AWS access key ID, and password is

   AWS secret access key

5. [Profile file](https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/auth/credentials/ProfileCredentialsProvider.html)

6. [Container metadata](https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/auth/credentials/ContainerCredentialsProvider.html) (e.g. EC2)

7. [EC2 Instance Metadata Service](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/auth/credentials/InstanceProfileCredentialsProvider.html)

You're done! You can now use `s3://` scheme in the following format (base directory is optional):

```text

s3://{bucket}/{base-directory}

```

This works in both `` and ``, for pulling artifacts, as well as

``, for pushing artifacts.

```xml

   

   

      

         red-team-releases

         s3://red-team-maven/releases

      

      

         red-team-snapshots

         s3://red-team-maven/snapshots

      

   

   

      

         blue-team-releases

         s3://blue-team-maven-releases

      

   

```

---

This repo was written from scratch, but took cues from [seahen/maven-s3-wagon](https://github.com/seahen/maven-s3-wagon),

which in turn was forked from [jcaddel/maven-s3-wagon](https://github.com/jcaddel/maven-s3-wagon/). They are no longer

maintained, and the Amazon SDK they are based on is being phased out.

Major differences:

 - Removed support for plain HTTP

 - `Wagon::getFileList` and `Wagon::putDirectory` are not supported. Judging by

   [AbstractWagon](https://github.com/apache/maven-wagon/blob/master/wagon-provider-api/src/main/java/org/apache/maven/wagon/AbstractWagon.java)

   they're optional, and I don't know what they're used for.

 - Won't create the bucket if it doesn't exist

If you need these things then raise an issue explaining your use-case.