README.md in jets_gem_layer-0.1 vs README.md in jets_gem_layer-1.0.0
- old
+ new
@@ -12,11 +12,11 @@
* Docker is a prerequisite and must be installed to use this gem.
* This gem has not been tested to work on windows machines.
## Installation
-1. Jets Pro would typically be disabled when using this gem so as to not generate multiple Lambda Layers.
+1. Jets Pro would typically be disabled when using this gem so as to not generate duplicative Lambda Layers.
```ruby
# config/application.rb
config.pro.disable = true
@@ -53,14 +53,16 @@
```
3. After running `bundle install`, run `rake -T` and you should see this Gem's tasks available for use.
```
➜ rake -T
-rake gem_layer:build_and_publish # Build, publish, and clean
-rake gem_layer:build # Build the gem layer zip file
-rake gem_layer:publish # Publish the built gem laye zip to AWS
-rake gem_layer:clean # Clean up the gem's tmp files
+rake gem_layer:build_and_publish # Build, publish, and clean (will be a no-op if already published)
+rake gem_layer:build # Build the gem layer zip file
+rake gem_layer:publish # Publish the built gem laye zip to AWS
+rake gem_layer:clean # Clean up the gem's tmp files
+rake gem_layer:cleanup_published # Deletes all prior versions of the lamda layer from AWS
+rake gem_layer:delete_all_published # Deletes all versions of the lamda layer from AWS
```
## Configuration
The following environmental variables may be used:
@@ -70,11 +72,15 @@
* `GEM_LAYER_PACKAGE_DEPENDENCIES`: use this to identify comma separated dependencies required for bundle install
specific to your Gemfile. For example, to build the `mysql2` gem you will need to set `GEM_LAYER_PACKAGE_DEPENDENCIES=mysql-devel`.
Dependencies will be installed within the build container and copied into the published Lambda Layer.
## Deployment
-Within your project directory (example for development environment):
-1. run `JETS_ENV=development rake gem_layer:build_and_publish`
-2. run `JETS_ENV=development jets deploy`
+Within your project directory (example for development environment) or through your CI/CD platform:
+1. `JETS_ENV=development JETS_AGREE=no rake gem_layer:build_and_publish`
+ * If needed, builds and publishes a new gem layer version based on the current Jets namespace, Gemfile.lock and Gemfile
+2. `JETS_ENV=development JETS_AGREE=no jets deploy`
+ * Deploy your application
+3. `JETS_ENV=development JETS_AGREE=no rake gem_layer:cleanup_published`
+ * After a successful deploy, you may run this to cleanup the old gem layer version(s) no longer in use
## Acknowledgements
A big thank you to the authors of [Lambda Layer Cake](https://github.com/loganb/lambda-layer-cake), which served as a reference.
\ No newline at end of file