Skip to content

Latest commit

 

History

History
126 lines (112 loc) · 3.66 KB

readme.md

File metadata and controls

126 lines (112 loc) · 3.66 KB

s3-upload-maven-plugin

Uses this snapshot temporarly if you want to have metadatas and properties functionality:

<pluginRepository>
  <id>moacyrricardo s3-upload-maven-plugin</id>
  <url>https://raw.github.com/moacyrricardo/s3-upload-maven-plugin/master/mvn-repo</url>
  <!-- use snapshot version -->
  <snapshots>
    <enabled>true</enabled>
    <updatePolicy>always</updatePolicy>
  </snapshots>
</pluginRepository>

====================== Uploads a file or (recursively) the contents of a directory to S3.

Configuration parameters

Parameter Description Required Default
bucketName The name of the bucket yes
source The source file or folder (was sourceFile before 1.2) yes
destination The destination file or destination folder (was destinationFile before 1.2) yes
recursive If this is a directory copy, recursively copy all contents (since 1.2) no false
accessKey S3 access key no if unspecified, uses the Default Provider, falling back to env variables
secretKey S3 secret key no if unspecified, uses the Default Provider, falling back to env variables
doNotUpload Dry run no false
endpoint Use a different s3 endpoint no s3.amazonaws.com

Example: Upload a file

<build>
  ...

  <plugins>
    ...

    <plugin>
      <groupId>com.bazaarvoice.maven.plugins</groupId>
      <artifactId>s3-upload-maven-plugin</artifactId>
      <version>1.2</version>
      <configuration>
        <bucketName>my-s3-bucket</bucketName>
        <source>dir/filename.txt</source>
        <destination>remote-dir/remote-filename.txt</destination>
      </configuration>
    </plugin>
  </plugins>
</build>

Example: Recursively upload a folder

<build>
  ...

  <plugins>
    ...

    <plugin>
      <groupId>com.bazaarvoice.maven.plugins</groupId>
      <artifactId>s3-upload-maven-plugin</artifactId>
      <version>1.0</version>
      <configuration>
        <bucketName>my-s3-bucket</bucketName>
        <source>dir</source>
        <destination>remote-dir</destination>
        <recursive>true</recursive>
      </configuration>
    </plugin>
  </plugins>
</build>

Example: Upload setting metadata and permissions

<build>
  ...

  <plugins>
    ...

    <plugin>
      <groupId>com.bazaarvoice.maven.plugins</groupId>
      <artifactId>s3-upload-maven-plugin</artifactId>
      <version>1.0</version>
      <configuration>
        <skip>false</skip> <!-- may be used to skip execution, useful when pom has lots of conditions -->
        <bucketName>my-s3-bucket</bucketName>
        <source>dir</source>
        <destination>remote-dir</destination>
        <recursive>true</recursive>
	<permissions>
          <permission>
            <grantee>Everyone</grantee><!-- S3 Values || email || others -->
            <download>true</download>
            <viewPermission>true</viewPermission><!-- optional;default false -->
            <editPermission>true</editPermission><!-- optional;default false -->
          </permission>
        </permissions>
        <metadatas>
          <metadata>
            <key>Content-Type</key>
            <value>application/x-javascript</value>
            <matches>\\.js$</matches><!-- Regex used to match file types when applying metadata -->
          </metadata>
        </metadatas>
      </configuration>
    </plugin>
  </plugins>
</build>

Example: run the plugin

mvn com.bazaarvoice.maven.plugins:s3-upload-maven-plugin:1.2:s3-upload