@cjpablo92/semantic-release-ecr v1.0.17

@cjpablo92/semantic-release-ecr

semantic-release plugin to publish a docker image to the AWS Elastic Container Registry using AWS IAM roles, forked from RimacTechnology/semantic-release-ecr, also adding the ability to build and push multiple components at the same time.

Install

# For npm users
$ npm install --save-dev @cjpablo92/semantic-release-ecr

# For yarn users
$ yarn add --dev @cjpablo92/semantic-release-ecr

Usage

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

Push single component

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/npm",
        [
            "@cjpablo92/semantic-release-ecr",
            {
                "imageName": "my-ecr-image"
            }
        ]
    ]
}

Push multiple components

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/npm",
        [
            "@cjpablo92/semantic-release-ecr",
            {
                "config": [
                    {
                        "imageName": "my-ecr-image-component-1"
                    },
                    {
                        "imageName": "my-ecr-image-component-2"
                    }
                ]
            }
        ]
    ]
}

Prerequisites

To use this plugin you need to set up an ECR container registry if you don't already have on. Here is a AWS ECR Getting started guide from AWS on how to set up a new registry.

IMPORTANT! This plugin expects the docker image to be built already, or you can build it with "dockerImage" configuration option

Configuration

Environment variables

Note: If AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are not present it will use the default credentials and their fallbacks (like IAM roles).

Options

Example

Build and push single component

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/npm",
        [
            "@cjpablo92/semantic-release-ecr",
            {
                "buildImage": "docker build . -t my-ecr-image",
                "imageName": "my-ecr-image",
                "tags": ["latest", "$NODE_ENV"],
                "bumpParents": false,
                "suffix": "sufix"
            }
        ]
    ]
}

Build and push multiple components

{
    "plugins": [
        "@semantic-release/commit-analyzer",
        "@semantic-release/release-notes-generator",
        "@semantic-release/npm",
        [
            "@cjpablo92/semantic-release-ecr",
            { 
                "config": [
                    {
                        "buildImage": "docker build . -t my-ecr-image-component-1",
                        "imageName": "my-ecr-image",
                        "tags": ["latest", "$NODE_ENV", "component-1"],
                        "bumpParents": false,
                        "suffix": "component-1"
                    },
                    {
                        "buildImage": "docker build . -t my-ecr-image-component-2",
                        "imageName": "my-ecr-image",
                        "tags": ["latest", "$NODE_ENV", "component-2"],
                        "bumpParents": false,
                        "suffix": "component-2"
                    }
                ]
            }
        ]
    ]
}

Run locally

npm install -g tsx
npx tsx src/localRun.ts