Export GIT_USER and GIT_EMAIL env and tags vars by default.

Fixes jacob-meacham#56.

Author: navrkald

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/jacob-meacham/serverless-plugin-git-variables.svg?branch=develop)](https://travis-ci.org/jacob-meacham/serverless-plugin-git-variables)
 
 Expose git variables (HEAD description, branch name, short commit hash, message, git tags, and if the local repo has changed files) to your serverless services.
-Moreover, it adds GIT related environment variables and tags (GIT_COMMIT_SHORT, GIT_COMMIT_LONG, GIT_BRANCH, GIT_IS_DIRTY, GIT_REPOSITORY, GIT_TAGS) for each defined function in the serverless file. You can disable this by adding the following custom variable in your serverless.yml file:
+Moreover, it adds GIT related environment variables and tags (GIT_COMMIT_SHORT, GIT_COMMIT_LONG, GIT_BRANCH, GIT_IS_DIRTY, GIT_REPOSITORY, GIT_TAGS, GIT_USER, GIT_EMAIL) for each defined function in the serverless file. You can disable this by adding the following custom variable in your serverless.yml file:
 
 ```
 custom:

lib/index.js

@@ -152,7 +152,7 @@ class ServerlessGitVariables {
         return;
       }
 
-      const exportList = [{ value: 'sha1', variableName: 'GIT_COMMIT_SHORT' }, { value: 'commit', variableName: 'GIT_COMMIT_LONG' }, { value: 'branch', variableName: 'GIT_BRANCH' }, { value: 'isDirty', variableName: 'GIT_IS_DIRTY' }, { value: 'repository', variableName: 'GIT_REPOSITORY' }, { value: 'tags', variableName: 'GIT_TAGS' }];
+      const exportList = [{ value: 'sha1', variableName: 'GIT_COMMIT_SHORT' }, { value: 'commit', variableName: 'GIT_COMMIT_LONG' }, { value: 'branch', variableName: 'GIT_BRANCH' }, { value: 'isDirty', variableName: 'GIT_IS_DIRTY' }, { value: 'repository', variableName: 'GIT_REPOSITORY' }, { value: 'tags', variableName: 'GIT_TAGS' }, { value: 'user', variableName: 'GIT_USER' }, { value: 'email', variableName: 'GIT_EMAIL' }];
 
       for (const functionName of _this3.serverless.service.getAllFunctions()) {
         const func = _this3.serverless.service.getFunction(functionName);

src/index.js

@@ -119,7 +119,9 @@ export default class ServerlessGitVariables {
       { value: 'branch', variableName: 'GIT_BRANCH' },
       { value: 'isDirty', variableName: 'GIT_IS_DIRTY' },
       { value: 'repository', variableName: 'GIT_REPOSITORY' },
-      { value: 'tags', variableName: 'GIT_TAGS' }
+      { value: 'tags', variableName: 'GIT_TAGS' },
+      { value: 'user', variableName: 'GIT_USER' },
+      { value: 'email', variableName: 'GIT_EMAIL' }
     ]
 
     for (const functionName of this.serverless.service.getAllFunctions()) {

test/index.spec.js

@@ -173,12 +173,16 @@ test.serial('Env variables defined', async t => {
   t.is(func.environment.GIT_BRANCH, 'another_branch')
   t.is(func.environment.GIT_IS_DIRTY, 'false')
   t.is(func.environment.GIT_TAGS, '90440bd')
+  t.is(func.environment.GIT_USER, 'Full User')
+  t.is(func.environment.GIT_EMAIL, '[email protected]')
 
   t.is(func.tags.GIT_COMMIT_SHORT, '90440bd')
   t.is(func.tags.GIT_COMMIT_LONG, '90440bdc8eb3b2fa20bc578f411cf4b725ae0a25')
   t.is(func.tags.GIT_BRANCH, 'another_branch')
   t.is(func.tags.GIT_IS_DIRTY, 'false')
   t.is(func.tags.GIT_TAGS, '90440bd')
+  t.is(func.tags.GIT_USER, 'Full User')
+  t.is(func.tags.GIT_EMAIL, '[email protected]')
 })
 
 test.serial('Whitelist', async t => {
@@ -212,15 +216,19 @@ test.serial('Whitelist', async t => {
   t.is(func.environment.GIT_BRANCH, undefined)
   t.is(func.environment.GIT_IS_DIRTY, 'false')
   t.is(func.environment.GIT_TAGS, undefined)
+  t.is(func.environment.GIT_USER, undefined)
+  t.is(func.environment.GIT_EMAIL, undefined)
 
   t.is(func.tags.GIT_COMMIT_SHORT, undefined)
   t.is(func.tags.GIT_COMMIT_LONG, '90440bdc8eb3b2fa20bc578f411cf4b725ae0a25')
   t.is(func.tags.GIT_BRANCH, undefined)
   t.is(func.tags.GIT_IS_DIRTY, undefined)
   t.is(func.tags.GIT_TAGS, '90440bd')
+  t.is(func.tags.GIT_USER, undefined)
+  t.is(func.tags.GIT_EMAIL, undefined)
 })
 
-test.serial('User/Email not exported', async t => {
+test.serial('User/Email is exported', async t => {
   fs.copySync('test/resources/full_repo/git', `${t.context.tmpDir}/.git`)
   process.chdir(t.context.tmpDir)
 
@@ -242,11 +250,11 @@ test.serial('User/Email not exported', async t => {
   const plugin = new ServerlessGitVariables(fakeServerless, {})
   await plugin.exportGitVariables()
 
-  t.is(func.environment.GIT_USER, undefined)
-  t.is(func.environment.GIT_EMAIL, undefined)
+  t.is(func.environment.GIT_USER, 'Full User')
+  t.is(func.environment.GIT_EMAIL, '[email protected]')
 
-  t.is(func.tags.GIT_USER, undefined)
-  t.is(func.tags.GIT_EMAIL, undefined)
+  t.is(func.tags.GIT_USER, 'Full User')
+  t.is(func.tags.GIT_EMAIL, '[email protected]')
 })
 
 test.serial('Disabling export of env variables', async t => {
@@ -276,6 +284,8 @@ test.serial('Disabling export of env variables', async t => {
   t.is(func.environment.GIT_BRANCH, undefined)
   t.is(func.environment.GIT_IS_DIRTY, undefined)
   t.is(func.environment.GIT_TAGS, undefined)
+  t.is(func.environment.GIT_USER, undefined)
+  t.is(func.environment.GIT_EMAIL, undefined)
 
   t.is(func.tags, undefined)
 })