https://github.com/wnkz/codebuilder

CLI helper for AWS CodeBuild and CodePipeline
https://github.com/wnkz/codebuilder

aws codebuild codepipeline docker kms

Last synced: 3 days ago
JSON representation

CLI helper for AWS CodeBuild and CodePipeline

• Host: GitHub
• URL: https://github.com/wnkz/codebuilder
• Owner: wnkz
• License: mit
• Created: 2017-02-16T11:31:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-04-10T12:20:50.000Z (over 4 years ago)
• Last Synced: 2024-09-27T09:11:39.392Z (about 2 months ago)
• Topics: aws, codebuild, codepipeline, docker, kms
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 4
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
CodeBuilder - CLI helper for easy CI on AWS

===========================================

|Build Status| |Docs| |Version| |License|

CodeBuilder is a CLI tool which allows developpers to use simple commands

and helpers inside AWS CI/CD tools like CodePipeline and CodeBuild.

.. _`stable docs`: https://codebuilder.readthedocs.io/en/stable/

.. _`Read the Docs`: https://codebuilder.readthedocs.io/en/latest/

.. |Build Status| image:: https://img.shields.io/travis/wnkz/codebuilder/master.svg?style=flat

    :target: https://travis-ci.org/wnkz/codebuilder

    :alt: Build Status

.. |Docs| image:: https://readthedocs.org/projects/codebuilder/badge/?version=latest

    :target: http://codebuilder.readthedocs.io/en/latest/?badge=latest

    :alt: Read the docs

.. |Version| image:: https://img.shields.io/pypi/v/codebuilder.svg?style=flat

    :target: https://pypi.python.org/pypi/codebuilder/

    :alt: Version

.. |License| image:: http://img.shields.io/pypi/l/codebuilder.svg?style=flat

    :target: https://github.com/wnkz/codebuilder/blob/master/LICENSE

    :alt: License

Quick Start

-----------

Generally, you would run CodeBuilder on an `AWS CodeBuild environment `__

where AWS CLI is properly installed and configured. CodeBuilder uses the exact same authentication method as Boto 3 and AWS CLI.

Install with ``pip``:

.. code-block:: sh

    $ pip install codebuilder

Example CodeBuild usage (``buildspec.yml``):

.. code-block:: yaml

    version: 0.1

    environment_variables:

      plaintext:

        KMS_CIPHERBLOB: "AQEC..."

    phases:

      install:

        commands:

          - pip install codebuilder

      pre_build:

        commands:

          - codebuilder aws ecr login

          - codebuilder aws kms decrypt ${KMS_CIPHERBLOB} > ${CODEBUILD_SRC_DIR}/secret

      build:

        commands:

          - docker build -t 123456789012.dkr.ecr.eu-west-1.amazonaws.com/foo .

      post_build:

        commands:

          - docker push 123456789012.dkr.ecr.eu-west-1.amazonaws.com/foo

          - codebuilder docker --image-name 123456789012.dkr.ecr.eu-west-1.amazonaws.com/foo get-image full --source-json-file config.json --in-place Parameters DockerImage

          - codebuilder aws ecr prune