Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 3.29 KB

README.MD

File metadata and controls

53 lines (33 loc) · 3.29 KB
Raw

AWS ECS Orb for CircleCI

CircleCI Build Status CircleCI Orb Version GitHub License CircleCI Community

A CircleCI Orb to simplify deployments to Amazon Elastic Container Service (ECS). Supports EC2 and Fargate launch type deployments.

Features

This orb allows convenient updating of ECS services when only the Docker image name/tag and/or environment variables in a service's container definitions need to be updated. A sample project that demonstrates using the orb is available on this GitHub repository branch: https://github.com/CircleCI-Public/circleci-demo-aws-ecs-ecr

Resources

CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described. CircleCI Orb Docs - Docs for using and creating CircleCI Orbs.

Usage

See the orb registry listing for usage guidelines.

Requirements

  • python should be available in PATH. Supported versions are Python 2 version 2.7.1 and above and Python 3 version 3.4.9 and above.
  • The aws CLI should be available in PATH. Otherwise, pip is required to be available as the job will then attempt to install aws via pip. The default profile of aws will be used.
  • bash to be present in /bin/bash. Otherwise, /bin/sh will be used, but the orb has not been tested for compatibility with other shells.

How to Contribute

We welcome issues to and pull requests against this repository!

For internal contributors, please view the development docs: here

How to Publish

  • Create and push a branch with your new features.
  • When ready to publish a new production version, create a Pull Request from fore feature branch to master.
  • The title of the pull request must contain a special semver tag: [semver:<segement>] where <segment> is replaced by one of the following values.
Increment Description
major Issue a 1.0.0 incremented release
minor Issue a x.1.0 incremented release
patch Issue a x.x.1 incremented release
skip Do not issue a release

Example: [semver:major]

  • Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.
  • On merge, after manual approval, the orb will automatically be published to the Orb Registry.

For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.