You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ This plugin library helps to provide Java runtime bindings for the execution of
7
7
Usage
8
8
-----
9
9
10
-
If you are using this package to build resource providers for CloudFormation, install the (CloudFormation CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk] and the (CloudFormation CLI Java Plugin)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin]
10
+
If you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI](https://github.com/aws-cloudformation/aws-cloudformation-rpdk) and the [CloudFormation CLI Java Plugin](https://github.com/aws-cloudformation/aws-cloudformation-rpdk-java-plugin)
11
11
12
-
```
12
+
```shell
13
13
pip3 install cloudformation-cli
14
14
pip3 install cloudformation-cli-java-plugin
15
15
```
@@ -19,15 +19,15 @@ Refer to the documentation for the [CloudFormation CLI](https://github.com/aws-c
19
19
Development
20
20
-----------
21
21
22
-
First, you will need to install the (CloudFormation CLI)[https://github.com/aws-cloudformation/aws-cloudformation-rpdk], as it is a required dependency:
22
+
First, you will need to install the [CloudFormation CLI](https://github.com/aws-cloudformation/aws-cloudformation-rpdk), as it is a required dependency:
23
23
24
-
```
24
+
```shell
25
25
pip3 install cloudformation-cli
26
26
```
27
27
28
28
For changes to the plugin, a Python virtual environment is recommended.
29
29
30
-
```
30
+
```shell
31
31
python3 -m venv env
32
32
source env/bin/activate
33
33
# assuming cloudformation-cli has already been cloned/downloaded
@@ -37,7 +37,7 @@ pre-commit install
37
37
38
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):
39
39
40
-
```
40
+
```shell
41
41
# run all hooks on all files, mirrors what the CI runs
42
42
pre-commit run --all-files
43
43
# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local
0 commit comments