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
A Serverless Plugin to bundle ruby gems from Gemfile and deploy it to lambda layer automatically while running `severless deploy`.
5
+
A Serverless Plugin to bundle ruby gems from Gemfile and deploy it to the lambda layer automatically while running `serverless deploy`.
6
6
7
-
It autoconfigures the lamda layer and RUBY_PATH to the all the functions.
7
+
It auto-configures the AWS lambda layer and RUBY_PATH to all the functions.
8
8
9
9
## Install
10
10
@@ -51,15 +51,15 @@ functions:
51
51
gem 'httparty'
52
52
```
53
53
54
-
Running `servleress deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
54
+
Running `serverless deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
55
55
56
56
Refer [example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) amd [docs](https://navarasu.github.io/serverless-ruby-layer) for more details
57
57
58
58
### Customization
59
59
60
-
The plugin operation can be customized by specifying `custom` configuration under `rubyLayer`.
60
+
The plugin operation can be customized by specifying the `custom` configuration under `rubyLayer`.
61
61
62
-
For example to use docker environment for packing gem, the below configuration is added to `serverless.yml`
62
+
For example, to use docker environment for packing gem, the below configuration is added to `serverless.yml`
63
63
64
64
```YML
65
65
custom:
@@ -76,14 +76,14 @@ Using the custom configuration, the plugin can be utilized for below cases,
76
76
* Using locallly installed bundler for gems which native extensions - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/use_local_bundler)
77
77
* Using Docker for gems with OS native C extensions or system libraries like `http`, `Nokogiri` - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/use_docker)
78
78
* Preinstall OS packages (yum packages) for gems which requires OS native system libraries like `pg`, `mysql`, `RMagick` - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker_with_yums) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/use_docker_with_yums)
79
-
* Using Dockerfile for gems which with other OS linux image or system libraries and utilities - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker_file) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/use_docker_file)
79
+
* Using Dockerfile for gems which with other OS Linux image or system libraries and utilities - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker_file) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/use_docker_file)
80
80
81
81
82
82
## Contributing
83
83
84
84
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
85
85
86
-
Please make sure to update tests as appropriate.
86
+
Please make sure to update the tests as appropriate.
A Serverless Plugin to bundle ruby gems from Gemfile and deploy it to lambda layer automatically while running `severless deploy`.
6
+
A Serverless Plugin to bundle ruby gems from Gemfile and deploy it to the lambda layer automatically while running `serverless deploy`.
7
7
8
-
It autoconfigures the lamda layer and RUBY_PATH to the all the functions.
8
+
It auto-configures the AWS lambda layer and RUBY_PATH to all the functions.
9
9
10
10
## Install
11
11
@@ -52,15 +52,15 @@ functions:
52
52
gem 'httparty'
53
53
```
54
54
55
-
Running `servleress deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
55
+
Running `serverless deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
56
56
57
57
Refer [example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) amd [docs](https://navarasu.github.io/serverless-ruby-layer) for more details
58
58
59
59
### Customization
60
60
61
-
The plugin operation can be customized by specifying `custom` configuration under `rubyLayer`.
61
+
The plugin operation can be customized by specifying the `custom` configuration under `rubyLayer`.
62
62
63
-
For example to use docker environment for packing gem, the below configuration is added to `serverless.yml`
63
+
For example, to use docker environment for packing gem, the below configuration is added to `serverless.yml`
64
64
65
65
```YML
66
66
custom:
@@ -77,14 +77,14 @@ Using the custom configuration, the plugin can be utilized for below cases,
77
77
* Using locallly installed bundler for gems which native extensions - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) - [Docs](https://navarasu.github.io/serverless-ruby-layer/use_docker)
78
78
* Using Docker for gems with OS native C extensions or system libraries like `http`, `Nokogiri` - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker) - [Docs](https://navarasu.github.io/serverless-ruby-layer/use_docker)
79
79
* Preinstall OS packages (yum packages) for gems which requires OS native system libraries like `pg`, `mysql`, `RMagick` - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker_with_yums) - [Docs](https://navarasu.github.io/serverless-ruby-layer/use_docker_with_yums)
80
-
* Using Dockerfile for gems which with other OS linux image or system libraries and utilities - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker_file) - [Docs](https://navarasu.github.io/serverless-ruby-layer/use_docker_file)
80
+
* Using Dockerfile for gems which with other OS Linux image or system libraries and utilities - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use_docker_file) - [Docs](https://navarasu.github.io/serverless-ruby-layer/use_docker_file)
81
81
82
82
83
83
## Contributing
84
84
85
85
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
86
86
87
-
Please make sure to update tests as appropriate.
87
+
Please make sure to update the tests as appropriate.
Copy file name to clipboardExpand all lines: docs/quickstart.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,6 @@ functions:
34
34
gem 'httparty'
35
35
```
36
36
37
-
Running `servleress deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
37
+
Running `serverless deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
38
38
39
39
Refer [example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) and [docs](serverless-ruby-layer/#/use_local_bundler) for more details
0 commit comments