Can you record the git revision with gruntjs

Question

I build my webapp with gruntjs and yeoman.io.

I'd like to be able to record the git revision/commit/sha that a build come from, so that i can look in the deployed version and double check where it came from and what has changed with the new release.

score 13 · Answer 1 · answered Jul 17 '13 at 08:49

Not a Grunt expert either, but here's a solution based on git describe which I currently use for a large AngularJS app. We store the major version in the project's package.json. In addition to that I generate a version.json file containing the revision and date for every build. This information can later be accessed by the client to help testers and maintainers to see which version/revision of the app they're using.

grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),

  'git-describe': {
    options: {
      prop: 'meta.revision'
    },
    me: {}
  },

  ...
});

grunt.registerTask('tag-revision', 'Tag the current build revision', function () {
  grunt.task.requires('git-describe');

  grunt.file.write('public/version.json', JSON.stringify({
    version: grunt.config('pkg.version'),
    revision: grunt.config('meta.revision'),
    date: grunt.template.today()
  }));
});

grunt.registerTask('version', ['git-describe', 'tag-revision']);

So by including the version task in our build tasks we can tag each build with a version.json file.

This isn't working for me or my combination of npm versions. Here's the open issue: https://github.com/mikaelkaron/grunt-git-describe/issues/10 — SimplGy, Aug 26 '13 at 20:40
Just a side comment: git-describe v2.2.0 "Removed support for callback and prop (use grunt.event.emit instead)" — Lucas Pottersky, Nov 20 '13 at 11:15

score 6 · Answer 2 · edited May 23 '17 at 12:24

Not a gruntjs specialist, but maybe you can include in your build step a call to the gruntjs-git-describe module, which will call that task:

module.exports = function( grunt ) {
  grunt.registerTask("describe", "Describes current git commit", function (prop) {
    var done = this.async();

    grunt.log.write("Describe current commit: ");

    grunt.util.spawn({
      cmd : "git",
      args : [ "describe", "--tags", "--always", "--long", "--dirty" ]
    }, function (err, result) {
      if (err) {
        grunt.log.error(err);
        return done(false);
      }

      grunt.config(prop || "meta.version", result);

      grunt.log.writeln(result.green);

      done(result);
    });
  });
};

Using git-describe is a good way to record a "version number" with Git, as it is SHA1-based (unambiguous id).
See more on that topic:

score 3 · Answer 3 · answered Jun 13 '14 at 12:52

To elaborate on Lucas Pottersky's comment to inukshuk's answer, the correct way to do the same thing with grunt-git-describe >= 2.2.0 is the following:

grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),

  'git-describe': {
    options: {
    },
    me: {}
  },

  ...
});

grunt.registerTask('saveRevision', function() {
  grunt.event.once('git-describe', function (rev) {
    grunt.option('gitRevision', rev);
  });
  grunt.task.run('git-describe');
});

grunt.registerTask('tag-revision', 'Tag the current build revision', function () {
  grunt.task.requires('git-describe');

  grunt.file.write('public/version.json', JSON.stringify({
    version: grunt.config('pkg.version'),
    revision: grunt.option('gitRevision'),
    date: grunt.template.today()
  }));
});

grunt.registerTask('version', ['saveRevision', 'tag-revision']);

Can you record the git revision with gruntjs

3 Answers3