Release 0.2.1

.gitattributes

@@ -1 +1,2 @@
 *.py linguist-detectable=false
+docs/demo.gif filter=lfs diff=lfs merge=lfs -text

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.1 (2021-01-08)
+
+* Update documentation (no code changes)
+
 ## 0.2.0 (2021-01-05)
 
 * Migrate from dedent-js to ts-dedent

README.md

@@ -13,6 +13,9 @@ This project was heavily influenced by [cdk8s](https://github.com/awslabs/cdk8s/
 
 * [Overview](#overview)
 * [Why](#why)
+* [At a glance](#at-a-glance)
+* [Validation workflow](#validation-workflow)
+* [Library](#library)
 * [Getting Started](#getting-started)
 * [Examples](#examples)
 * [License](#license)
@@ -29,6 +32,21 @@ cdkactions was built because [composite actions](https://docs.github.com/en/free
 
 On top of that, cdkactions provides additional features like strong type-checking as well as significantly better modularity.
 
+## At a glance
+
+![demo](docs/demo.gif)
+
+## Validation workflow
+
+cdkactions provides a validation workflow that ensures `.yaml` manifests are up to date with cdkactions configuration. This workflow can also push updated manifests when it detects any changes by setting the `pushUpdatedManifests` flag to true. However, if this option is enabled you must create a GitHub Actions secret called `CDKACTIONS_TOKEN` that contains a [Personal Access Token](https://github.com/settings/tokens) with the `workflow` scope (This workaround is required because the default GitHub token [doesn't have permission to change workflow files](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)).
+
+## Library
+
+cdkactions also contains a library of additional constructs:
+
+* CheckoutJob - A job that inserts a checkout step as the first step to run.
+* CDKActionsStack - A stack that contains the validation workflow described above.
+
 ## Getting Started
 
 * [TypeScript](./docs/getting-started/typescript.md)

docs/getting-started/typescript.md

@@ -28,6 +28,14 @@ This will:
 
 The final step is to actually use cdkactions. See the [examples directory](../../examples/typescript/) or the [API guide](../../packages/cdkactions/API.md) for additional information.
 
+## Tips & Tricks
+
+When defining a multiline run command for a step inside of a job, a package like [ts-dedent](https://www.npmjs.com/package/ts-dedent) may be useful to strip additional indentation from multiline strings. See the [PyPI Publish example](../../examples/typescript/pypi-publish/) for an example of how to use it.
+
+## API Reference
+
+To see a list of all cdkactions constructs and properties see the [API reference](../../packages/cdkactions/API.md)
+
 ## Synthesize manifests
 
 When you make changes to your cdkactions project and want to update the `.yaml` manifests, just run the following command in the `cdk` folder:

lerna.json

@@ -1,5 +1,5 @@
 {
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.2.0"
+  "version": "0.2.1"
 }

packages/cdkactions-cli/README.md

@@ -1,6 +1,6 @@
 # cdkactions-cli
 
-See the [Getting Started guides](../../docs/getting-started) for installation and usage instructions
+See the [Getting Started guides](https://github.com/ArmaanT/cdkactions/tree/master/docs/getting-started) for installation and usage instructions
 
 ## License
 

packages/cdkactions/README.md

@@ -1,8 +1,8 @@
 # cdkactions
 
-See the [main README](../../README.md) for an overview of cdkactions.
+See the [main README](https://github.com/ArmaanT/cdkactions/) for an overview of cdkactions.
 
-See the [API reference](./API.md) for detailed information about the cdkactions constructs.
+See the [API reference](https://github.com/ArmaanT/cdkactions/blob/master/packages/cdkactions/API.md) for detailed information about the cdkactions constructs.
 
 ## License