Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.37 KB

README.md

File metadata and controls

59 lines (39 loc) · 2.37 KB
Raw

AWS CloudFormation Resource Provider Go Plugin

The CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.

This plugin library helps to provide Go runtime bindings for the execution of your providers by CloudFormation.

Usage

If you are using this package to build resource providers for CloudFormation, install the CloudFormation CLI Go Plugin - this will automatically install the the CloudFormation CLI! A Python virtual environment is recommended.

pip3 install cloudformation-cli-go-plugin

Refer to the documentation for the CloudFormation CLI for usage instructions.

Development

For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:

python3 -m venv env
source env/bin/activate
pip3 install -e /path/to/cloudformation-cli-go-plugin

You may also want to check out the CloudFormation CLI if you wish to make edits to that. In this case, installing them in one operation works well:

pip3 install \
  -e /path/to/cloudformation-cli \
  -e /path/to/cloudformation-cli-go-plugin

That ensures neither is accidentally installed from PyPI.

Linting and running unit tests is done via pre-commit, and so is performed automatically on commit. The continuous integration also runs these checks. Manual options are available so you don't have to commit:

# run all hooks on all files, mirrors what the CI runs
pre-commit run --all-files
# run unit tests only. can also be used for other hooks, e.g. black, isort, pytest-local
pre-commit run pytest-local

Use ./generate-examples.sh to run install cloudformation-cli-go-plugin locally and run cfn generate in each example.

Getting started

This plugin create a sample Go project and requires golang 1.8 or above and godep. For more information on installing and setting up your Go environment, please visit the official Golang site.

License

This library is licensed under the Apache 2.0 License.