git - 你能用 gruntjs 记录 git 的修订吗

Question

我用 gruntjs 和 yeoman.io 构建我的 webapp。

我希望能够记录构建来自的 git revision/commit/sha，以便我可以查看已部署的版本并仔细检查它的来源以及新版本的变化。

Answer 1

也不是 Grunt 专家，但这里有一个基于 git describe 的解决方案，我目前用于大型 AngularJS 应用程序。我们将主要版本存储在项目的 package.json 中。除此之外，我还生成了一个 version.json 文件，其中包含每个构建的修订版和日期。客户端稍后可以访问此信息，以帮助测试人员和维护人员查看他们正在使用的应用程序的版本/修订版。

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']);

因此，通过在我们的构建任务中包含版本任务，我们可以使用 version.json 文件标记每个构建。

Answer 2

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:

• "Deriving application build version from git describe - how to get a relatively straightforward string?"
• "Moving from CVS to git: $Id:$ equivalent?"
• "what is the git equivalent for revision number?"

Answer 3

为了详细说明 Lucas Pottersky 对 inukshuk 的回答的评论，使用 grunt-git-describe >= 2.2.0 做同样事情的正确方法如下：

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']);