Skip to content
☁️Amazon S3-based resolver for sbt
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs/src Autogenerated literator docs for v0.18.0 Sep 26, 2017
notes
project Updated the build Oct 17, 2017
src Minor formatting changes Oct 17, 2017
.gitignore Pre-release preparations Jun 15, 2015
.travis.yml Updated Travis config Oct 17, 2017
LICENSE
Readme.md
build.sbt

Readme.md

Sbt S3 resolver

This is an sbt plugin which helps resolving dependencies from and publish to Amazon S3 buckets (private or public).

It can publish artifacts in maven or ivy style, but it can resolve only ivy artifacts:

Ivy artifacts publish resolve Maven artifacts publish resolve
public public *
private private

Usage

Plugin sbt dependency

In project/plugins.sbt:

resolvers += Resolver.jcenterRepo
addSbtPlugin("ohnosequences" % "sbt-s3-resolver" % "<version>")

(see the latest release version on the badge above)

Notes

  • Since v0.17.0 this plugin is compiled and published only for sbt-1.+. If you need it for sbt-0.13, use v0.16.0.
  • If you are using Java 9 and encounter problems, check information in #58.

Settings

  • awsProfile: AWS configuration profile
  • s3credentials: AWS credentials provider to access S3
  • s3region: AWS Region for your S3 resolvers
  • s3acl: Controls whether published artifacts are accessible publicly via http(s) or not
  • s3storageClass: Controls storage class for the published S3 objects
  • s3overwrite: Controls whether publishing resolver can overwrite artifacts
  • s3sse: Controls whether publishing resolver will use server side encryption
Key Type Default
awsProfile Option[String] None
s3credentials AWSCredentialsProvider DefaultAWSCredentialsProviderChain
s3region Region DefaultAwsRegionProviderChain
s3acl Option[CannedAccessControlList] Some(PublicRead)
s3storageClass StorageClass Standard
s3overwrite Boolean isSnapshot.value
s3sse Boolean false

These defaults are added to your project automatically. So if you're fine with them, you don't need to do anything special, just set the resolver and publish. Otherwise you can tune the settings by overriding them in your build.sbt.

You can use s3resolver setting key that takes a name and an S3 bucket url and returns S3Resolver which is implicitly converted to sbt.Resolver.

AWS configuration profiles

If you have different configuration profiles, you can choose the one you need by setting

awsProfile := Some("my-profile")

If you didn't touch s3region and s3credentials settings, they will both use this profile region and credentials.

By default awsProfile is set to None which means that both region and credentials will be set from the default provider chains. See below for details.

Credentials

s3credentials key has the AWSCredentialsProvider type from AWS Java SDK. Different kinds of providers look for credentials in different places, plus they can be chained. DefaultAWSCredentialsProviderChain looks in

  1. Environment Variables:
    • AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
    • or AWS_ACCESS_KEY and AWS_SECRET_KEY
  2. Java System Properties: aws.accessKeyId and aws.secretKey
  3. Credential profiles file: ~/.aws/credentials shared by all AWS SDKs and the AWS CLI
  4. ECS container credentials loaded from the Amazon ECS if the environment variable AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set
  5. Instance profile credentials delivered through the Amazon EC2 metadata service

You can find other types of credentials providers in the AWS Java SDK docs.

If you changed the awsProfile setting, default credentials provider becomes that of the corresponding profile. To check which credentials are used by the plugin, use showS3Credentials task.

Region

You can set the s3region setting in a number of ways:

By default it is set to the DefaultAwsRegionProviderChain which is similar to the default credentials provider chain and includes

  1. Environment Variable: AWS_REGION
  2. Java System Property: aws.region
  3. Profiles configuration file: ~/.aws/config
  4. EC2 instance metadata service

If you changed the awsProfile setting, default region provider becomes that of the corresponding profile.

Publishing

A common practice is to use different (snapshots and releases) repositories depending on the version. For example, here is such publishing resolver with ivy-style patterns:

publishMavenStyle := false

publishTo := {
  val prefix = if (isSnapshot.value) "snapshots" else "releases"
  Some(s3resolver.value(s"My ${prefix} S3 bucket", s3(s"${prefix}.cool.bucket.com")) withIvyPatterns)
}

You can also switch repository for public and private artifacts — you just set the url of your bucket depending on something. Here s3 constructor takes the name of your S3 bucket (don't worry about s3:// prefix).

Resolving

You can add a sequence of S3 resolvers just like this:

resolvers ++= Seq[Resolver](
  s3resolver.value("Releases resolver", s3("releases.bucket.com")),
  s3resolver.value("Snapshots resolver", s3("snapshots.bucket.com"))
)

Note, that you have to write Seq[Resolver] explicitly, so that S3Resolvers will be converted to sbt.Resolver before appending.

Public Maven artifacts

If your maven artifacts are public, you can resolve them using usual sbt resolvers just transforming your s3://my.bucket.com to

"My S3 bucket" at "https://s3-<region>.amazonaws.com/my.bucket.com"

i.e. without using this plugin. Or if you're using it anyway, you can write:

"My S3 bucket" at s3("my.bucket.com").toHttps(s3region.value)

Patterns

You can set patterns using .withPatterns(...) method of S3Resolver. Default are maven-style patterns (just as in sbt), but you can change it with the convenience method .withIvyPatterns.

S3 IAM policy

If you want to publish and resolve artifacts in an S3 bucket you should have at least these permissions on your AWS-user/role:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": "arn:aws:s3:::mybucket"
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:PutObjectAcl",
                "s3:GetObject"
            ],
            "Resource": "arn:aws:s3:::mybucket/*"
        }
    ]
}

In theory s3:CreateBucket may be also needed in the first statement in case if you publish to a non-existing bucket.

You can’t perform that action at this time.