Module: GitVersionBump

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

Defined Under Namespace

Classes: VersionUnobtainable

Constant Summary collapse

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.



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
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/git-version-bump.rb', line 192

def self.commit_date_version(use_local_git = false)
  if use_local_git
    unless git_available?
      raise RuntimeError,
            "GVB.commit_date_version(use_local_git=true) called, but git isn't installed"
    end

    sq_git_dir = "'#{Dir.pwd.gsub("'", "'\\''")}'"
  else
    # Shell Quoted, for your convenience
    sq_git_dir = "'" + (File.dirname(caller_file) rescue nil || Dir.pwd).gsub("'", "'\\''") + "'"
  end

  commit_dates = `git -C #{sq_git_dir} log --format=%at`.
                 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 tags?  If so, dump out our
  # super-special version and be done with it.
  system("git -C #{sq_git_dir} status >/dev/null 2>&1")
  $? == 0 ? "0.0.0.1.ENOCOMMITS" : gem_version(use_local_git)
end

.date(use_local_git = false) ⇒ Object 



80
81
82
83
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
110
111
112
113
114
115
116
117
118
 
# File 'lib/git-version-bump.rb', line 80

def self.date(use_local_git=false)
  if use_local_git
    unless git_available?
      raise RuntimeError,
            "GVB.date(use_local_git=true), but git is not installed"
    end

    sq_git_dir = "'#{Dir.pwd.gsub("'", "'\\''")}'"
  else
    # Shell Quoted, for your convenience
    sq_git_dir = "'" + (File.dirname(caller_file) rescue nil || Dir.pwd).gsub("'", "'\\''") + "'"
  end

  # Are we in a git tree?
  system("git -C #{sq_git_dir} status >/dev/null 2>&1")
  if $? == 0
    # Yes, we're in git.

    if dirty_tree?
      return Time.now.strftime("%F")
    else
      # Clean tree.  Date of last commit is needed.
      return `git -C #{sq_git_dir} show --format=format:%cd --date=short | head -n 1`.strip
    end
  else
    if use_local_git
      raise RuntimeError,
            "GVB.date(use_local_git=true) called from non-git location"
    end

    # Not in git; time to hit the gemspecs
    if spec = caller_gemspec
      return spec.date.strftime("%F")
    end

    raise RuntimeError,
          "GVB.date called from mysterious, non-gem location."
  end
end

.internal_revision(use_local_git = false) ⇒ Object 



76
77
78
 
# File 'lib/git-version-bump.rb', line 76

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

.major_version(use_local_git = false) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/git-version-bump.rb', line 40

def self.major_version(use_local_git=false)
  ver = version(use_local_git)
  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) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/git-version-bump.rb', line 52

def self.minor_version(use_local_git=false)
  ver = version(use_local_git)
  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) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/git-version-bump.rb', line 64

def self.patch_version(use_local_git=false)
  ver = version(use_local_git)
  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) ⇒ Object 



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
161
162
163
 
# File 'lib/git-version-bump.rb', line 120

def self.tag_version(v, release_notes = false)
  if dirty_tree?
    puts "You have uncommitted files.  Refusing to tag a dirty tree."
  else
    if release_notes
      # 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.
      prev_tag = `git describe --always`.strip.gsub(/-\d+-g[0-9a-f]+$/, '')

      log_file = Tempfile.new('gvb')

      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\n      log_file.close\n      system(\"git log --format='# %h  %s' \#{prev_tag}..HEAD >>\#{log_file.path}\")\n\n      pre_hash = Digest::SHA1.hexdigest(File.read(log_file.path))\n      system(\"git config -e -f \#{log_file.path}\")\n      if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash\n        puts \"Release notes not edited; aborting\"\n        log_file.unlink\n        return\n      end\n\n      puts \"Tagging version \#{v}...\"\n      system(\"git tag -a -F \#{log_file.path} v\#{v}\")\n      log_file.unlink\n    else\n      # Crikey this is a lot simpler\n      system(\"git tag -a -m 'Version v\#{v}' v\#{v}\")\n    end\n\n    system(\"git push >/dev/null 2>&1\")\n    system(\"git push --tags >/dev/null 2>&1\")\n  end\nend\n".gsub(/^\t\t\t\t\t/, '')

.version(use_local_git = false) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/git-version-bump.rb', line 8

def self.version(use_local_git=false)
  if use_local_git
    unless git_available?
      raise RuntimeError,
            "GVB.version(use_local_git=true) called, but git isn't installed"
    end

    sq_git_dir = "'#{Dir.pwd.gsub("'", "'\\''")}'"
  else
    # Shell Quoted, for your convenience
    sq_git_dir = "'" + (File.dirname(caller_file) rescue nil || Dir.pwd).gsub("'", "'\\''") + "'"
  end

  git_ver = `git -C #{sq_git_dir} describe --dirty='.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}' --match='v[0-9]*.[0-9]*.*[0-9]' 2>/dev/null`.
              strip.
              gsub(/^v/, '').
              gsub('-', '.')

  # If git returned success, then it gave us a described version.
  # Success!
  return git_ver if $? == 0

  # 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, dump out our
  # super-special version and be done with it, otherwise try to use the
  # gem version.
  system("git -C #{sq_git_dir} status >/dev/null 2>&1")
   "0.0.0.1.ENOTAG" if $? == 0 ? "0.0.0.1.ENOTAG" : gem_version(use_local_git)
end