serverless-plugin-warmup 8.0.0 → 8.1.0

package/README.md

@@ -4,7 +4,7 @@
 [![npm monthly downloads][npm-downloads-badge]][npm-version-badge-url]
 [![Node.js CI](https://github.com/juanjoDiaz/serverless-plugin-warmup/actions/workflows/on-push.yaml/badge.svg)](https://github.com/juanjoDiaz/serverless-plugin-warmup/actions/workflows/on-push.yaml)
 [![Coverage Status][coveralls-badge]][coveralls-badge-url]
-[![license](https://img.shields.io/npm/l/serverless-plugin-warmup.svg)](https://raw.githubusercontent.com/juanjoDiaz/serverless-plugin-warmup/master/LICENSE)
+[![license](https://img.shields.io/npm/l/serverless-plugin-warmup.svg)](https://raw.githubusercontent.com/juanjoDiaz/serverless-plugin-warmup/main/LICENSE)
 
 Keep your lambdas warm during winter.
 
@@ -63,6 +63,7 @@ The options are the same for all the warmers:
 * **folderName** Folder to temporarily store the generated code (defaults to `.warmup`)
 * **cleanFolder** Whether to automatically delete the generated code folder. You might want to keep it if you are doing some custom packaging (defaults to `true`)
 * **name** Name of the generated warmer lambda (defaults to `${service}-${stage}-warmup-plugin-${warmerName}`)
+* **roleName** Name to be applied to the default warmer lambda role. Ignored if a the role setting is used (defaults to `${service.service}-${stage}-${region}-${warmerName.toLowerCase()}-role`)
 * **role** Role to apply to the warmer lambda (defaults to the role in the provider)
 * **tags** Tag to apply to the generated warmer lambda (defaults to the serverless default tags)
 * **vpc** The VPC and subnets in which to deploy. Can be any [Serverless VPC configuration](https://serverless.com/framework/docs/providers/aws/guide/functions#vpc-configuration) or be set to `false` in order to deploy the warmup function outside of a VPC (defaults to the vpc in the provider)
@@ -95,6 +96,7 @@ custom:
       cleanFolder: false
       memorySize: 256
       name: warmer-default
+      roleName: my-custom-role
       role: WarmupRole
       tags:
         Project: foo
@@ -610,8 +612,8 @@ This software is released under the MIT license. See [the license file](LICENSE)
 [npm-version-badge]: https://badge.fury.io/js/serverless-plugin-warmup.svg
 [npm-version-badge-url]: https://www.npmjs.com/package/serverless-plugin-warmup
 [npm-downloads-badge]: https://img.shields.io/npm/dm/serverless-plugin-warmup.svg
-[coveralls-badge]: https://coveralls.io/repos/juanjoDiaz/serverless-plugin-warmup/badge.svg?branch=master
-[coveralls-badge-url]: https://coveralls.io/r/juanjoDiaz/serverless-plugin-warmup?branch=master
+[coveralls-badge]: https://coveralls.io/repos/juanjoDiaz/serverless-plugin-warmup/badge.svg?branch=main
+[coveralls-badge-url]: https://coveralls.io/r/juanjoDiaz/serverless-plugin-warmup?branch=main
 
 ## Acknowledgements
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-plugin-warmup",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "Keep your lambdas warm during winter.",
   "main": "src/index.js",
   "scripts": {
@@ -35,6 +35,6 @@
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.24.2",
     "husky": "^8.0.1",
-    "jest": "^28.1.3"
+    "jest": "^29.1.2"
   }
 }

package/src/config.js

@@ -15,6 +15,7 @@ function getWarmerConfig(config, defaultOpts) {
     pathHandler: path.join(folderName, 'index.warmUp'),
     cleanFolder: (typeof config.cleanFolder === 'boolean') ? config.cleanFolder : defaultOpts.cleanFolder,
     name: (config.name !== undefined) ? config.name : defaultOpts.name,
+    roleName: (config.roleName !== undefined) ? config.roleName : defaultOpts.roleName,
     role: (config.role !== undefined) ? config.role : defaultOpts.role,
     tags: (config.tags !== undefined) ? config.tags : defaultOpts.tags,
     vpc: config.vpc === false ? { securityGroupIds: [], subnetIds: [] }

package/src/schema.js

@@ -15,6 +15,7 @@ function extendServerlessSchema(serverless) {
     folderName: { type: 'string' },
     cleanFolder: { type: 'boolean' },
     name: { type: 'string' },
+    roleName: { type: 'string' },
     role: { $ref: '#/definitions/awsLambdaRole' },
     tags: { $ref: '#/definitions/awsResourceTags' },
     vpc: {

package/src/warmer.js

@@ -26,7 +26,7 @@ function addWarmUpFunctionRoleToResources(service, stage, warmerName, warmerConf
     Type: 'AWS::IAM::Role',
     Properties: {
       Path: '/',
-      RoleName: {
+      RoleName: warmerConfig.roleName || {
         'Fn::Join': [
           '-',
           [
@@ -233,6 +233,7 @@ function addWarmUpFunctionToService(service, warmerName, warmerConfig) {
     ...(warmerConfig.logRetentionInDays !== undefined
       ? { logRetentionInDays: warmerConfig.logRetentionInDays }
       : {}),
+    ...(warmerConfig.roleName ? { roleName: warmerConfig.roleName } : {}),
     ...(warmerConfig.role ? { role: warmerConfig.role } : {}),
     ...(warmerConfig.tags ? { tags: warmerConfig.tags } : {}),
     ...(warmerConfig.vpc ? { vpc: warmerConfig.vpc } : {}),