{"id":18890456,"url":"https://github.com/navarasu/serverless-ruby-layer","last_synced_at":"2025-07-07T20:03:39.878Z","repository":{"id":39869067,"uuid":"199639183","full_name":"navarasu/serverless-ruby-layer","owner":"navarasu","description":"A Serverless Plugin to deploy gems from Gemfile to AWS Layer","archived":false,"fork":false,"pushed_at":"2024-03-19T00:16:59.000Z","size":711,"stargazers_count":72,"open_issues_count":8,"forks_count":11,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-19T03:41:03.033Z","etag":null,"topics":["aws","aws-lambda","aws-lambda-layer","aws-lambda-ruby","aws-layers","bundler","gemfile","ruby","ruby-gem","serverless","serverless-plugin","serverless-ruby"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/navarasu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-30T11:33:11.000Z","updated_at":"2024-05-07T15:29:13.000Z","dependencies_parsed_at":"2024-06-19T22:51:17.540Z","dependency_job_id":"cb83de6d-9b40-4e3b-b240-1943d3d096ef","html_url":"https://github.com/navarasu/serverless-ruby-layer","commit_stats":{"total_commits":92,"total_committers":4,"mean_commits":23.0,"dds":0.2065217391304348,"last_synced_commit":"fd0bf0ed610485a05c37c3fe9aff2ecd4ee25925"},"previous_names":["navarasu/serverless-ruby-gemfile"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/navarasu/serverless-ruby-layer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navarasu%2Fserverless-ruby-layer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navarasu%2Fserverless-ruby-layer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navarasu%2Fserverless-ruby-layer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navarasu%2Fserverless-ruby-layer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/navarasu","download_url":"https://codeload.github.com/navarasu/serverless-ruby-layer/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/navarasu%2Fserverless-ruby-layer/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261003957,"owners_count":23095700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-lambda","aws-lambda-layer","aws-lambda-ruby","aws-layers","bundler","gemfile","ruby","ruby-gem","serverless","serverless-plugin","serverless-ruby"],"created_at":"2024-11-08T07:55:39.387Z","updated_at":"2025-06-25T05:04:59.125Z","avatar_url":"https://github.com/navarasu.png","language":"JavaScript","readme":"\u003ch1\u003e\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://navarasu.github.io/serverless-ruby-layer/assets/serverless-ruby-layer.png\"\u003e\n  \u003cimg height=\"75\" src=\"https://navarasu.github.io/serverless-ruby-layer/assets/serverless-ruby-layer-wh.png\"\u003e\n\u003c/picture\u003e\n\u003c/h1\u003e\n  \n[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)  [![npm](https://img.shields.io/npm/v/serverless-ruby-layer.svg)](https://www.npmjs.com/package/serverless-ruby-layer) [![Build Status](https://img.shields.io/circleci/build/github/navarasu/serverless-ruby-layer)](https://circleci.com/gh/navarasu/serverless-ruby-layer) [![Coverage Status](https://coveralls.io/repos/github/navarasu/serverless-ruby-layer/badge.svg?branch=master)](https://coveralls.io/github/navarasu/serverless-ruby-layer?branch=master) [![MIT License](https://img.shields.io/npm/l/serverless-ruby-layer)](https://github.com/navarasu/serverless-ruby-layer/blob/master/LICENSE)\n\nA Serverless Plugin which bundles ruby gems from Gemfile and deploys them to the lambda layer automatically while running `serverless deploy`.\n\nIt auto-configures the AWS lambda layer and RUBY_PATH to all the functions.\n\n## Install\n\nInstall ⚡️ [serverless](https://www.serverless.com/). Refer [here](https://www.serverless.com/framework/docs/getting-started/) for serverless installation instructions.\n\nNavigate to your serverless project and install the plugin\n\n```\nsls plugin install -n serverless-ruby-layer\n```\n\n*This will add the plugin to `package.json` and the plugins section of `serverless.yml`.*\n\n## Documentation\n\nCheck out the documentation [here](https://navarasu.github.io/serverless-ruby-layer) for,\n\n* [Quick Start](https://navarasu.github.io/serverless-ruby-layer/#/quickstart)\n* [Usage and Examples](https://navarasu.github.io/serverless-ruby-layer/#/usage_examples)\n* [Configuration](https://navarasu.github.io/serverless-ruby-layer/#/configuration)\n* [Release Notes](https://navarasu.github.io/serverless-ruby-layer/#/release_notes)\n\n## Getting Started\n\n### Simple Usage\n\n*`serverless.yml`*\n\n```yml\nservice: basic\n\nplugins:\n  - serverless-ruby-layer\n\nprovider:\n  name: aws\n  runtime: ruby3.2\n\nfunctions:\n  hello:\n    handler: handler.hello\n  ```\n\n*`Gemfile`*\n\n```ruby\n  source 'https://rubygems.org'\n  gem 'httparty'\n```\n\nRunning `sls 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`\n\nRefer [example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) amd [docs](https://navarasu.github.io/serverless-ruby-layer) for more details\n\n### Customization\n\nThe plugin operation can be customized by specifying the `custom` configuration under `rubyLayer`. \n\nFor example, to use docker environment for packing gem, the below configuration is added to `serverless.yml`\n\n```YML\ncustom:\n  rubyLayer:\n    use_docker: true\n  ```\n\nFor more detailse refer the docs [here](https://navarasu.github.io/serverless-ruby-layer/#/configuration)\n\n## Usage\n\nUsing the custom configuration, the plugin can be utilized for below cases,\n* Using locally installed bundler for gems without any 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)\n* 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)\n* Preinstall OS packages (yum packages) for gems which requires OS native system libraries like `pg`, `mysql`, `RMagick` - [PG Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use-docker-with-yums-pg-old) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/use_docker_with_yums)\n* 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)\n* Using Docker / Dockerfile with environment variable - [Docker Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use-docker-with-environment) - [DockerFile Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/use-docker-file-with-environment) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/environment)\n* Include / Exclude specific functions from layer configuration - [Include Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/include-functions) , [Exclude Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/exclude-functions) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/include_exclude)\n* Exclude test and development related gems from layer  - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/exclude-dev-test-gems) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/exclude_dev_test_gems)\n* Using `Bundler.require(:default)` to require all gems in handler.rb by respecting Gemfile.lock  - [Example](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/bundler-require-all) - [Docs](https://navarasu.github.io/serverless-ruby-layer/#/bundler_require_all)\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update the tests as appropriate.\n\nRefer [Guidelines](https://github.com/navarasu/serverless-ruby-layer/blob/master/CONTRIBUTING.md)  for more information.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnavarasu%2Fserverless-ruby-layer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnavarasu%2Fserverless-ruby-layer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnavarasu%2Fserverless-ruby-layer/lists"}