https://github.com/mridang/serverless-shortsha-plugin
A plugin for the Serverless framework to add add a custom alias for the current commit
https://github.com/mridang/serverless-shortsha-plugin
aws cloudformation custom-resources git iac serverless serverless-plugin version
Last synced: 12 months ago
JSON representation
A plugin for the Serverless framework to add add a custom alias for the current commit
- Host: GitHub
- URL: https://github.com/mridang/serverless-shortsha-plugin
- Owner: mridang
- License: apache-2.0
- Created: 2024-06-07T02:08:51.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-05T06:08:09.000Z (over 1 year ago)
- Last Synced: 2024-11-19T00:48:02.433Z (over 1 year ago)
- Topics: aws, cloudformation, custom-resources, git, iac, serverless, serverless-plugin, version
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@mridang/serverless-shortsha-plugin
- Size: 1.23 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A plugin for the Serverless framework to create a version alias
for the Lambda function which is named after the current git
SHA.
This makes it easier to deduce the version that is running.
> [!NOTE]
> This plugin has only been tested with the AWS provider and will
> not work if you are deploying to other providers e.g. GCP.
## Installation
Install using NPM by using the following command
```sh
npm install --save-dev @mridang/serverless-shortsha-plugin
```
And then add the plugin to your `serverless.yml` file:
```yaml
plugins:
- @mridang/serverless-shortsha-plugin
```
A thorough guide on installing plugins can be found at
https://www.serverless.com/framework/docs-guides-plugins
## Usage
There isn't anything specific to be done once the plugin is installed.
When you trigger a deployment, the plugin will take the short SHA
of the current directory (assuming that the project is in fact a
a Git repository).
```
$ sls deploy
Deploying test-logcls to stage dev (us-east-1)
Compiling with Typescript...
Using local tsconfig.json - tsconfig.json
Typescript compiled.
Warning: Package patterns at function level are only applicable if package.individually is set to true at service level or function level in serverless.yaml. The framework will ignore the patterns defined at the function level and apply only the service-wide ones.
Warning: cloudformation scan results:
Alias "40d313f" added for function "ProbotLambdaFunction" in the CloudFormation template
✔ Service deployed to stack test-logcls-dev (104s)
endpoint: https://sfukfimmof3tinylzdbum77uvdu0xtznt.lambda-url.us-east-1.on.aws/
functions:
probot: test-logcls-dev-probot (22 MB)
Need a faster logging experience than CloudWatch? Try our Dev Mode in Console: run "serverless dev"
```
## Contributing
If you have suggestions for how this app could be improved, or
want to report a bug, open an issue - we'd love all and any
contributions.
## License
Apache License 2.0 © 2024 Mridang Agarwalla