serverless-git-info
v1.2.4
Published
Serverless plugin for that exposes git info as serverless variables
Downloads
1,493
Maintainers
Readme
serverless-git-info
Exposes git information extracted from the current local repository as Serverless variables. Similar to serverless-plugin-git-variables, but without exporting as environment variables and without a dependency on babel-runtime.
Installation
npm install serverless-git-info --save-dev
Usage
Add the following to your serverless.yml
:
plugins:
- serverless-git-info
custom:
# Each of these variables resolves to the response of the git command in the comment,
# as executed in the directory where you're deploying from
gitBranch: ${git:branch} # git rev-parse --abbrev-ref HEAD
gitCommit: ${git:commit} # git rev-parse HEAD
gitSha1: ${git:sha1} # git rev-parse --short HEAD
gitUser: ${git:user.name} # git config user.name
gitEmail: ${git:user.email} # git config user.email
# You can also combine them as any other Serverless variable
gitInfo: ${git:branch}@${git:sha1}
When you need to expose git info to your Lambda functions:
plugins:
- serverless-git-info
provider:
name: aws
environment:
# This will be available to all lambdas
GIT_COMMIT: ${git:commit}
functions:
test:
environment:
# This will only be available in the 'test' lambda
GIT_BRANCH: ${git:branch}
This plugin does not have any configuration options (yet).