A semantic-release plugin for publishing packages to AWS CodeArtifact.

Automate your entire package release workflow including: determining the next version number, generating release notes, and publishing packages to CodeArtifact using this plugin with semantic-release.

• Install
• Usage
• Demo
• Requirements
  • IAM Policy for Publishing
• Configuration
  • AWS Environment variables
  • Plugin environment variables
  • Options
• Lifecycle Hooks
• Recipes
  • CI Configurations
• Additional Usage
  • JavaScript - npm
    • Plugin Configuration with npm
  • Python - pip
  • Java - Maven
  • Java - Gradle
• Contributors ✨

npm install -D semantic-release semantic-release-codeartifact

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

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["semantic-release-codeartifact", {
      "tool": "npm",
      "domain": "<YOUR_DOMAIN>",
      "repository": "<YOUR_REPOSITORY>"
    }],
    "@semantic-release/npm",
    "@semantic-release/github"
  ]
}

See Additional Usage for details on using other tools with this plugin.

Check out this example repo to see it in action.

In order to use semantic-release you need:

• To host your code in a Git repository
• Use a Continuous Integration service that allows you to securely set up credentials
• A Git CLI version that meets semantic-release's version requirement installed in your Continuous Integration environment
• A Node.js version that meets semantic-release's version requirement installed in your Continuous Integration environment

In order to use semantic-release-codeartifact you need:

• An AWS Account
• An AWS CodeArtifact repository
• A role your CI environment can assume with sufficient IAM permissions to publish packages with CodeArtifact

The IAM role used by your CI environment will need the following permissions:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "codeartifact:GetAuthorizationToken",
        "codeartifact:GetRepositoryEndpoint",
        "codeartifact:PublishPackageVersion"
      ],
      "Resource": "*"
    },
    {
      "Effect": "Allow",
      "Action": "sts:GetServiceBearerToken",
      "Resource": "*",
      "Condition": {
        "StringEquals": {
          "sts:AWSServiceName": "codeartifact.amazonaws.com"
        }
      }
    }
  ]
}

The AWS configuration is required for the AWS SDK which is used for getting an auth token for CodeArtifact.

Note: Proxy configurations are supported and will be used if HTTP_PROXY or HTTPS_PROXY is found on the environment using aws-sdk-v3-proxy.

The following environment variables can be set to configure the plugin. Options specified by plugin config will take precedence over these environment variables.

• GitHub Actions
• GitLab (coming soon - PRs welcome)
• CircleCI (coming soon - PRs welcome)

CodeArtifact supports multiple tools including npm (JavaScript), Maven and Gradle (Java), and pip (Python). Each contain different dependencies and are listed below.

Required dependencies:

• @semantic-release/npm

npm install --save-dev semantic-release semantic-release-codeartifact

semantic-release includes the other plugins listed below:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["semantic-release-codeartifact", {
      "tool": "npm",
      "domain": "<YOUR_DOMAIN>",
      "repository": "<YOUR_REPOSITORY>"
    }],
    "@semantic-release/npm",
    "@semantic-release/github"
  ]
}

Note: semantic-release-codeartifact must be listed before @semantic-release/npm

Support for pip coming soon

Support for Maven coming soon

Support for Gradle coming soon

Thanks goes to these wonderful people (emoji key):

Ryan Sonshine 💻

Jared McAteer 🐛

Doron Pearl 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!