@rimac-technology/semantic-release-s3 v2.4.0

@rimac-technology/semantic-release-s3

semantic-release plugin to push files and folders to AWS S3 bucket

# For npm users
$ npm install --save-dev @rimac-technology/semantic-release-s3

# For yarn users
$ yarn add --dev @rimac-technology/semantic-release-s3

Usage

The plugin can be configured in the semantic-release configuration file:

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/npm",
        [
            "@rimac-technology/semantic-release-s3",
            {
                "s3Bucket": {
                    "branchName": "s3-bucket-name"
                },
                "directoryPath": "directoryName/**/*"
            }
        ]
    ]
}

Configuration

Environment variables

If AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY can not be set, you can set custom variables and override them in plugin options with accessKeyName and secretAccessKeyName.

Options

s3Bucket option

The s3Bucket name can contain variable, is is parsed with Lodash template. The following variables are available:

s3Bucket examples

The s3Bucket my-bucket/${nextRelease.version} will generate push your object to this path:

my-bucket/v1.0.0/your-directory-content

Example

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/npm",
        [
            "@rimac-technology/semantic-release-s3",
            {
                "awsAccessKeyName": "ACCESS_KEY_ENV_VARIABLE_NAME",
                "awsSecretAccessKeyName": "SECRET_ACCESS_KEY_ENV_VARIABLE_NAME",
                "s3Bucket": "s3-bucket-name",
                "objectACL": "public-read",
                "directoryPath": "directoryName/**/*",
                "removeDirectoryRoot": true,
                "removeDiff": false
            }
        ]
    ]
}