Skip to content

Commit ea5f4d9

Browse files
tobywfRJ Lohan
authored andcommitted
Remove buildspec, update README for simplified installation instructions (#217)
1 parent f2a42af commit ea5f4d9

File tree

4 files changed

+14
-47
lines changed

4 files changed

+14
-47
lines changed

NOTICE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
AWS CloudFormation RPDK Java Plugin
1+
CloudFormation CLI Java Plugin
22
Copyright 2018-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ This plugin library helps to provide Java runtime bindings for the execution of
77
Usage
88
-----
99

10-
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)
10+
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.
1111

1212
```shell
13-
pip3 install cloudformation-cli
1413
pip3 install cloudformation-cli-java-plugin
1514
```
1615

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

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

2423
```shell
25-
pip3 install cloudformation-cli
24+
python3 -m venv env
25+
source env/bin/activate
26+
pip3 install -e /path/to/cloudformation-cli-java-plugin
2627
```
2728

28-
For changes to the plugin, a Python virtual environment is recommended.
29+
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:
2930

3031
```shell
31-
python3 -m venv env
32-
source env/bin/activate
33-
# assuming cloudformation-cli has already been cloned/downloaded
34-
pip3 install -e .
35-
pre-commit install
32+
pip3 install \
33+
-e /path/to/cloudformation-cli \
34+
-e /path/to/cloudformation-cli-java-plugin
3635
```
3736

38-
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):
37+
That ensures neither is accidentally installed from PyPI.
38+
39+
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:
3940

4041
```shell
4142
# run all hooks on all files, mirrors what the CI runs

buildspec.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def find_version(*file_paths):
4141
entry_points={"rpdk.v1.languages": ["java = rpdk.java.codegen:JavaLanguagePlugin"]},
4242
license="Apache License 2.0",
4343
classifiers=[
44-
"Development Status :: 4 - Beta",
44+
"Development Status :: 5 - Production/Stable",
4545
"Environment :: Console",
4646
"Intended Audience :: Developers",
4747
"License :: OSI Approved :: Apache Software License",

0 commit comments

Comments
 (0)