Module: GitVersionBump

Defined in:
lib/git-version-bump.rb,
lib/git-version-bump/version.rb

Defined Under Namespace

Classes: CommandFailure, VersionUnobtainable

Constant Summary collapse

VERSION_TAG_GLOB = 
'v[0-9]*.[0-9]*.*[0-9]'
DEVNULL = 
Gem.win_platform? ? "NUL" : "/dev/null"
VERSION = 
GVB.version
MAJOR_VERSION = 
GVB.major_version
MINOR_VERSION = 
GVB.minor_version
PATCH_VERSION = 
GVB.patch_version
INTERNAL_REVISION = 
GVB.internal_revision
DATE = 
GVB.date

Class Method Summary collapse

Class Method Details

.commit_date_version(use_local_git = false) ⇒ Object

Calculate a version number based on the date of the most recent git commit.

Return a version format string of the form ‘“0.YYYYMMDD.N”`, where `YYYYMMDD` is the date of the “top-most” commit in the tree, and `N` is the number of other commits also made on that date.

This version format is not recommented for general use. It has benefit only in situations where the principles of Semantic Versioning have no real meaning, such as packages where there is little or no concept of “backwards compatibility” (eg packages which only contain images and other assets), or where the package can, for reasons outside that of the package itself, never break backwards compatibility (definitions of binary-packed structures shared amongst multiple systems).

The format of this commit-date-based version format allows for a strictly monotonically-increasing version number, aligned with the progression of the underlying git commit log.

One limitation of the format is that it doesn’t deal with the issue of package builds made from multiple divergent trees. Unlike ‘git-describe`-based output, there is no “commit hash” identity included in the version string. This is because of (ludicrous) limitations of the Rubygems format definition – the moment there’s a letter in the version number, the package is considered a “pre-release” version. Since hashes are hex, we’re boned. Sorry about that. Don’t make builds off a branch, basically.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/git-version-bump.rb', line 189

def self.commit_date_version(use_local_git = false)
  commit_dates = run_command(["git", "-C", git_dir(use_local_git), "log", "--no-show-signature", "--format=%at"], "getting dates of all commits").
                 split("\n").
                 map { |l| Time.at(Integer(l)).strftime("%Y%m%d") }

  if $? == 0
    # We got a log; calculate our version number and we're done.
    version_date = commit_dates.first
    commit_count = commit_dates.select { |d| d == version_date }.length - 1
    dirty_suffix = if dirty_tree?
      ".dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}"
    else
      ""
    end

    return "0.#{version_date}.#{commit_count}#{dirty_suffix}"
  end

  # git failed us; either we're not in a git repo or else it's a git
  # repo that's not got any commits.

  # Are we in a git repo with no commits?  If so, try to use the gemspec
  # and if that fails then abort
  begin
    return gem_version(use_local_git)
  rescue VersionUnobtainable
    return "0.0.0.1.ENOCOMMITS"
  end
end

.date(use_local_git = false) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/git-version-bump.rb', line 84

def self.date(use_local_git=false)
  # Are we in a git tree?
  begin
    try_command(["git", "-C", git_dir(use_local_git), "status"])

    if dirty_tree?(git_dir(use_local_git))
      Time.now.strftime("%F")
    else
      # Clean tree.  Date of last commit is needed.
      (run_command(["git", "-C", git_dir(use_local_git), "show", "--no-show-signature", "--format=format:%cd", "--date=short"], "getting date of last commit").lines.first || "").strip
    end
  rescue CommandFailure
    # Presumably not in a git tree
    if use_local_git
      raise RuntimeError,
            "GVB.date(use_local_git=true) called from non-git location"
    end

    if spec = caller_gemspec
      spec.date.strftime("%F")
    else
      raise RuntimeError,
            "GVB.date called from mysterious, non-gem location."
    end
  end
end

.internal_revision(use_local_git = false, include_lite_tags = false) ⇒ Object 



80
81
82
 
# File 'lib/git-version-bump.rb', line 80

def self.internal_revision(use_local_git=false, include_lite_tags=false)
  version(use_local_git, include_lite_tags).split('.', 4)[3].to_s
end

.major_version(use_local_git = false, include_lite_tags = false) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/git-version-bump.rb', line 44

def self.major_version(use_local_git=false, include_lite_tags=false)
  ver = version(use_local_git, include_lite_tags)
  v   = ver.split('.')[0]

  unless v =~ /^[0-9]+$/
    raise ArgumentError,
            "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
  end

  return v.to_i
end

.minor_version(use_local_git = false, include_lite_tags = false) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/git-version-bump.rb', line 56

def self.minor_version(use_local_git=false, include_lite_tags=false)
  ver = version(use_local_git, include_lite_tags)
  v   = ver.split('.')[1]

  unless v =~ /^[0-9]+$/
    raise ArgumentError,
            "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
  end

  return v.to_i
end

.patch_version(use_local_git = false, include_lite_tags = false) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/git-version-bump.rb', line 68

def self.patch_version(use_local_git=false, include_lite_tags=false)
  ver = version(use_local_git, include_lite_tags)
  v   = ver.split('.')[2]

  unless v =~ /^[0-9]+$/
    raise ArgumentError,
            "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
  end

  return v.to_i
end

.tag_version(v, release_notes = false, include_lite_tags = false) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/git-version-bump.rb', line 111

def self.tag_version(v, release_notes = false, include_lite_tags=false)
  if dirty_tree?
    puts "You have uncommitted files.  Refusing to tag a dirty tree."
    return false
  end
  if release_notes
    log_file = Tempfile.new('gvb')

    begin
      # We need to find the tag before this one, so we can list all the commits
      # between the two.  This is not a trivial operation.
      git_cmd = ["git", "describe", "--match=#{VERSION_TAG_GLOB}", "--always"]
      git_cmd << "--tags" if include_lite_tags

      prev_tag = run_command(git_cmd, "getting previous release tag").strip.gsub(/-\d+-g[0-9a-f]+$/, '')

      log_file.puts "\n\n\n        # Write your release notes above.  The first line should be the release name.\n        # To help you remember what's in here, the commits since your last release\n        # are listed below. This will become v\#{v}\n        #\n      EOF\n      log_file.puts run_command([\"git\", \"log\", \"--no-show-signature\", \"--format=# %h  %s\", \"\#{prev_tag}..HEAD\"], \"getting commit range of release\")\n\n      log_file.close\n\n      pre_hash = Digest::SHA1.hexdigest(File.read(log_file.path))\n      run_command([\"git\", \"config\", \"-e\", \"-f\", log_file.path], \"editing release notes\")\n      if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash\n        puts \"Release notes not edited; not making release\"\n        log_file.unlink\n        return\n      end\n\n      puts \"Tagging version \#{v}...\"\n      run_command([\"git\", \"tag\", \"-a\", \"-F\", log_file.path, \"v\#{v}\"], \"tagging release with annotations\")\n    ensure\n      log_file.unlink\n    end\n  else\n    # Crikey this is a lot simpler\n    run_command([\"git\", \"tag\", \"-a\", \"-m\", \"Version v\#{v}\", \"v\#{v}\"], \"tagging release\")\n  end\n\n  run_command([\"git\", \"push\"], \"pushing commits to the default remote repository\")\n  run_command([\"git\", \"push\", \"--tags\"], \"pushing tags to the default remote repository\")\nend\n".gsub(/^\t\t\t\t\t/, '')

.version(use_local_git = false, include_lite_tags = false) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/git-version-bump.rb', line 21

def self.version(use_local_git=false, include_lite_tags=false)
  git_cmd = ["git", "-C", git_dir(use_local_git), "describe", "--dirty=.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}", "--match=#{VERSION_TAG_GLOB}"]
  git_cmd << "--tags" if include_lite_tags

  begin
    run_command(git_cmd, "getting current version descriptor").
                strip.
                gsub(/^v/, '').
                gsub('-', '.')
  rescue CommandFailure
    # git failed us; we're either not in a git repo or else we've never
    # tagged anything before.

    # Are we in a git repo with no tags?  If so, try to use the gemspec
    # and if that fails then abort
    begin
      gem_version(use_local_git)
    rescue VersionUnobtainable
      "0.0.0.1.ENOTAG"
    end
  end
end