Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
AWS CloudFormation RPDK Java Plugin
CloudFormation CLI Java Plugin
Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@ This plugin library helps to provide Java runtime bindings for the execution of
Usage
-----

If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) and the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin)
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/cloudformation-cli-java-plugin) - this will automatically install the the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.

```shell
pip3 install cloudformation-cli
pip3 install cloudformation-cli-java-plugin
```

Expand All @@ -19,23 +18,25 @@ Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-c
Development
-----------

First, you will need to install the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli), as it is a required dependency:
For changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:

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

For changes to the plugin, a Python virtual environment is recommended.
You may also want to check out the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) if you wish to make edits to that. In this case, installing them in one operation works well:

```shell
python3 -m venv env
source env/bin/activate
# assuming cloudformation-cli has already been cloned/downloaded
pip3 install -e .
pre-commit install
pip3 install \
-e /path/to/cloudformation-cli \
-e /path/to/cloudformation-cli-java-plugin
```

Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), 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):
That ensures neither is accidentally installed from PyPI.

Linting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit after being installed (`pre-commit install`). The continuous integration also runs these checks. Manual options are available so you don't have to commit:

```shell
# run all hooks on all files, mirrors what the CI runs
Expand Down
34 changes: 0 additions & 34 deletions buildspec.yml

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def find_version(*file_paths):
entry_points={"rpdk.v1.languages": ["java = rpdk.java.codegen:JavaLanguagePlugin"]},
license="Apache License 2.0",
classifiers=[
"Development Status :: 4 - Beta",
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
Expand Down