Merge pull request #13 from alisdair/git-and-version-commit-key-generators

Add git-tag-commit and version-commit key generators

Author: Aaron Chambers

README.md

@@ -54,6 +54,7 @@ For detailed information on how configuration of plugins works, please refer to
 The type of [Key Generator](#key-generators) to be used.
 
 *Default:* `'file-hash'`
+*Alternatives:* `'git-tag-commit'`, `'version-commit'`
 
 ## Key Generators
 
@@ -83,6 +84,24 @@ The list of built project files. This option should be relative to `distDir` and
 
 *Default:* `context.distFiles`
 
+### Git Tag Commit generator
+
+Creates a key based on the most recent git tag and the currently checked-out commit. The tag is the tag identifier, followed by a `+` symbol, followed by the first 8 characters of the commit hash.
+
+For example, if your most recent git tag is `v2.0.3`, and the current commit is `0993043d49f9e0[...]`, this generator will return a revision of `v2.0.3+0993043d`.
+
+### Version Commit generator
+
+Similar to the Git Tag Commit generator, but uses the `package.json` version string instead of the git tag. The JSON file containing the version string can be configured with the `versionFile` option.
+
+#### Configuration Options
+
+##### versionFile
+
+The file containing your project's version number. Must be a JSON file with a top-level `version` key. Only used by the `version-commit` key generator.
+
+*Default:* `package.json`
+
 ## Prerequisites
 
 The following properties are expected to be present on the deployment `context` object:

index.js

@@ -20,6 +20,7 @@ module.exports = {
         distFiles: function(context) {
           return context.distFiles;
         },
+        versionFile: 'package.json',
       },
       didBuild: function(context) {
         var self = this;

lib/key-generators/git-tag-commit.js

@@ -0,0 +1,23 @@
+var CoreObject  = require('core-object');
+var gitRepoInfo = require('git-repo-info');
+var Promise     = require('ember-cli/lib/ext/promise');
+
+module.exports = CoreObject.extend({
+  generate: function() {
+    var path = gitRepoInfo._findRepo();
+
+    if (path === null) {
+      return Promise.reject('Could not find git repository');
+    }
+
+    var info = gitRepoInfo(path);
+    var tag = info.tag;
+    var sha = info.sha.slice(0, 8);
+
+    if (!info.tag || !sha) {
+      return Promise.reject('Could not build revision with tag `' + tag + '` and commit hash `' + sha + '`');
+    }
+
+    return Promise.resolve(info.tag + '+' + sha);
+  }
+});

lib/key-generators/index.js

@@ -1,3 +1,5 @@
 module.exports = {
-  "file-hash": require('./file-hash')
+  "file-hash": require('./file-hash'),
+  "git-tag-commit": require('./git-tag-commit'),
+  "version-commit": require('./version-commit')
 };

lib/key-generators/version-commit.js

@@ -0,0 +1,37 @@
+var CoreObject  = require('core-object');
+var gitRepoInfo = require('git-repo-info');
+var fs          = require('fs');
+var Promise     = require('ember-cli/lib/ext/promise');
+
+var denodeify   = require('rsvp').denodeify;
+var readFile    = denodeify(fs.readFile);
+
+module.exports = CoreObject.extend({
+  init: function(options) {
+    this._plugin = options.plugin;
+  },
+
+  generate: function() {
+    var versionFile = this._plugin.readConfig('versionFile');
+
+    var path = gitRepoInfo._findRepo();
+
+    if (path === null) {
+      return Promise.reject('Could not find git repository');
+    }
+
+    var info = gitRepoInfo(path);
+    var sha = info.sha.slice(0, 8);
+
+    return readFile(versionFile)
+      .then(function(contents) {
+        var json = JSON.parse(contents);
+
+        if (!json.version || !sha) {
+          return Promise.reject('Could not build revision with version `' + json.version + '` and commit hash `' + sha + '`');
+        }
+
+        return json.version + '+' + sha;
+      });
+  }
+});

package.json

@@ -46,8 +46,9 @@
   "dependencies": {
     "chalk": "^1.0.0",
     "core-object": "^1.1.0",
-    "ember-cli-deploy-plugin": "0.1.3",
     "ember-cli-babel": "^5.0.0",
+    "ember-cli-deploy-plugin": "0.1.3",
+    "git-repo-info": "^1.1.2",
     "minimatch": "^2.0.4",
     "rsvp": "^3.0.18"
   },

tests/fixtures/not-a-repo/package.json

@@ -0,0 +1,3 @@
+{
+  "version": "3.2.1"
+}

tests/fixtures/repo/dotgit/HEAD

@@ -0,0 +1 @@
+ref: refs/heads/master

tests/fixtures/repo/dotgit/config

@@ -0,0 +1,7 @@
+[core]
+	repositoryformatversion = 0
+	filemode = true
+	bare = false
+	logallrefupdates = true
+	ignorecase = true
+	precomposeunicode = true