ruby-on-rails - Railsアプリケーションのバージョン番号はどこに保存しますか？

Question

Railsアプリをバージョニングするときは、すばらしいセマンティックバージョニングパラダイムを使用します。私が持っていた1つの質問は、この番号をどこに保存するのが最適かということでした。/lib、environment.rbなどに保存されているのを見てきました。

人々がベストプラクティスについてどう思ったか疑問に思っていますか？

Answer 1

私の戦略は、VCS タグに任せることです (git はここに示されています)。

これをあなたに追加してくださいapplication.rb：

# Only attempt update on local machine
if Rails.env.development?
  # Update version file from latest git tag
  File.open('config/version', 'w') do |file|
    file.write `git describe --tags --always` # or equivalent
  end
end

config.version = File.read('config/version')

その後、アプリのどこからでもバージョンにアクセスできますRails.configuration.version

Answer 2

これには慣習があるとは本当に思いません。それはすべて、あなたにとって自然に思えることだと思います。

バージョン番号を配置できるいくつかの場所は次のとおりです。

• config/environment.rb
• config/application.rb
• config/initializers/version.rb

追加することにより：

VERSION = '1.0.0'

(上記から) どのオプションを選択しても、アプリの初期化時に VERSION 定数が設定されます。

私のブログでは、レイアウトのフッターを更新するだけです。バージョン番号は他の場所では使用されていないためです。

ただし、このlibフォルダーは再利用可能なモジュールを格納するためのものであるため、このフォルダーは少し奇妙に聞こえます。

Answer 3

私の好みは、生成するrakeタスクを作成することです

# config/initializers/version.rb
VERSION = ["1", "0", "f3d9da7"]

FWIW、私のレーキタスク：

task :create_version do
  desc "create VERSION.  Use MAJOR_VERSION, MINOR_VERSION, BUILD_VERSION to override defaults"

  version_file = "#{Rails.root}/config/initializers/version.rb"
  major = ENV["MAJOR_VERSION"] || 1
  minor = ENV["MINOR_VERSION"] || 0
  build = ENV["BUILD_VERSION"] || `git describe --always --tags`
  version_string = "VERSION = #{[major.to_s, minor.to_s, build.strip]}\n"
  File.open(version_file, "w") {|f| f.print(version_string)}
  $stderr.print(version_string)
end

Answer 4

個人的には、アプリケーション クラスに定数を追加することを好みます。

# file: config/initializers/version.rb
class SomeApp::Application
  Version = '1.0.0'
end

Answer 5

Rails 4 では、上記の @fearless_fool の rake タスクは次のようにする必要があります。

desc "create VERSION.  Use MAJOR_VERSION, MINOR_VERSION, BUILD_VERSION to override defaults"
task :create_version do
  version_file = "#{Rails.root}/config/initializers/version.rb"
  major = ENV["MAJOR_VERSION"] || 1
  minor = ENV["MINOR_VERSION"] || 0
  build = ENV["BUILD_VERSION"] || `git describe --always --tags`
  version_string = "VERSION = #{[major.to_s, minor.to_s, build.strip]}\n"
  File.open(version_file, "w") {|f| f.print(version_string)}
  $stderr.print(version_string)
end

rake がそれを認識するためには、行が存在し、行の前descに来なければなりません。task :create...

Answer 6

version.rake

def valid? version
  pattern = /^\d+\.\d+\.\d+(\-(dev|beta|rc\d+))?$/
  raise "Tried to set invalid version: #{version}".red unless version =~ pattern
end

def correct_version version
  ver, flag = version.split '-'
  v = ver.split '.'
  (0..2).each do |n|
    v[n] = v[n].to_i
  end
  [v.join('.'), flag].compact.join '-'
end

def read_version
  begin 
    File.read 'VERSION'
  rescue
    raise "VERSION file not found or unreadable.".red
  end
end

def write_version version
  valid? version
  begin
    File.open 'VERSION', 'w' do |file|
      file.write correct_version(version)
    end
  rescue
    raise "VERSION file not found or unwritable.".red
  end
end

def reset current, which
  version, flag = current.split '-'
  v = version.split '.'
  which.each do |part|
    v[part] = 0
  end
  [v.join('.'), flag].compact.join '-'
end

def increment current, which
  version, flag = current.split '-'
  v = version.split '.'
  v[which] = v[which].to_i + 1
  [v.join('.'), flag].compact.join '-'
end

desc "Prints the current application version"
version = read_version
task :version do
  puts <<HELP
Available commands are:
-----------------------
rake version:write[version]   # set custom version in the x.x.x-? format
rake version:patch            # increment the patch x.x.x+1 (keeps any flags on)
rake version:minor            # increment minor and reset patch x.x+1.0 (keeps any flags on)
rake version:major            # increment major and reset others x+1.0.0 (keeps any flags on)
rake version:dev              # set the dev flag on x.x.x-dev
rake version:beta             # set the beta flag on x.x.x-beta
rake version:rc               # set or increment the rc flag x.x.x-rcX
rake version:release          # removes any flags from the current version

HELP
  puts "Current version is: #{version.green}"
end

namespace :version do

  desc "Write version explicitly by specifying version number as a parameter"
  task :write, [:version] do |task, args|
    write_version args[:version].strip
    puts "Version explicitly written: #{read_version.green}"
  end

  desc "Increments the patch version"
  task :patch do
    new_version = increment read_version, 2
    write_version new_version
    puts "Application patched: #{new_version.green}"
  end

  desc "Increments the minor version and resets the patch"
  task :minor do
    incremented = increment read_version, 1
    new_version = reset incremented, [2]
    write_version new_version
    puts "New version released: #{new_version.green}"
  end

  desc "Increments the major version and resets both minor and patch"
  task :major do
    incremented = increment read_version, 0
    new_version = reset incremented, [1, 2]
    write_version new_version
    puts "Major application version change: #{new_version.green}. Congratulations!"
  end

  desc "Sets the development flag on"
  task :dev do
    version, flag = read_version.split '-'
    new_version = [version, 'dev'].join '-'
    write_version new_version
    puts "Version in development: #{new_version.green}"
  end

  desc "Sets the beta flag on"
  task :beta do
    version, flag = read_version.split '-'
    new_version = [version, 'beta'].join '-'
    write_version new_version
    puts "Version in beta: #{new_version.green}"
  end

  desc "Sets or increments the rc flag"
  task :rc do
    version, flag = read_version.split '-'
    rc = /^rc(\d+)$/.match flag
    if rc
      new_version = [version, "rc#{rc[1].to_i+1}"].join '-'
    else
      new_version = [version, 'rc1'].join '-'
    end
    write_version new_version
    puts "New version release candidate: #{new_version.green}"
  end

  desc "Removes any version flags"
  task :release do
    version, flag = read_version.split '-'
    write_version version
    puts "Released stable version: #{version.green}"
  end

end

Answer 7

gitgemを使用してイニシャライザを作成し、次を使用してアプリケーションのバージョンを設定できます。git describe

gitgem を開発グループに追加します。

# Gemfile
# ...
group :development do
  gem 'git'
  # ...
end

実行することを忘れないでくださいbundle。

新しい初期化ファイルを作成します。

# config/initializers/version.rb

if Rails.env.development?
  g = Git.open(Rails.root)
  version = g.describe
  puts "Setting application version to #{version}"
  File.write('config/VERSION', version)
end

module MyApp
  VERSION = File.read('config/VERSION').strip
end

これで、次のようにバージョンにアクセスできます。

➤  rails c
Setting application version to v2.1.3-7-gd5d8ea1
Loading development environment (Rails 5.2.3)
jruby-9.2.6.0 :001 > MyApp::VERSION
 => "v2.1.3-7-gd5d8ea1"