codeship-template

Docker images for CI/CD process and how to get started.

Getting Started

Prerequisites

• Docker
• Codeship Jet CLI

Basics

• codeship.aes is the password for decrypting env.encrypted
• codeship-services.yml contains the containers you're going to use
• codeship-steps.yml contains the build/deploy orchestration
• You can run the CI/CD locally with jet steps
• You can encrypt your env file by running jet encrypt env env.encrypted

.gitignore

# CI/CD
.env
env*
codeship.aes
!*.encrypted
.tmp

What you need

Copy the following files from /docs/samples into the root of your repo.

• codeship-services.yml
• codeship-steps.{one of}.yml
• env

Deployment Workflows

Static Assets (Angular/React/Vue) -> AWS S3

serverless -> AWS

docker -> AWS ECS

terraform

Containers

scripts

Collection of re-usable scripts

docker

Everything you need to build, scan, and push to any repository.

node

aws

Contains the aws-sdk cli.

terraform

Contains the terraform cli

Scripts

Global

• setup-env:
  • setup-environment:
  • setup-gitflow:

Android

AWS

• aws-env-check: Checks that the necessary env are set to execute aws-* scripts.
• aws-auth: Sets credentials to allow connection to AWS.
• aws-s3-deploy: Deploys static assets to a S3 bucket.

docker

• docker-env-check: Checks that the necessary env are set to execute docker-* scripts.
• docker-auth: Sets credentials to allow connection to private docker registry.
• docker-build: Builds docker image and pushes to registry.

npm

• npm-env-check: Checks that the necessary env are set to execute npm-* scripts.
• npm-auth: Sets credentials to allow connection to private npm registry.
• npm-version: Pull version from package.json and applies to env.

terraform

• terraform-: TODO

Built With

• CodeShip Jet - CI/CD CLI
• Docker - Linux Containers
• HashiCorp Terraform - Infrastructure as Code

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• will Farrell - Initial work - willfarrell

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

TODO

• Phase I:
  • static assets
  • serverless
• Phase II:
  • docker
  • ECS deploy (service, task)
  • terraform
• Phase III
  • terraform module aws-code-pipeline
• ensure all images have a USER line
• connect repo to docker hub, but disable auto build - to show dockerfile