1 2 3 4 5 6 7 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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 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 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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
|
# frozen_string_literal: true
require "json"
require "digest"
require "rake/tasklib"
class Releaser < Rake::TaskLib
# Order dependent. E.g. Action Mailbox depends on Active Record so it should be after.
FRAMEWORKS = %w(
activesupport
activemodel
activerecord
actionview
actionpack
activejob
actionmailer
actioncable
activestorage
actionmailbox
actiontext
railties
)
attr_reader :root, :version, :tag, :major, :minor, :tiny, :pre
def initialize(root, version)
@root = Pathname.new(root)
@version = version
@tag = "v#{version}"
@major, @minor, @tiny, @pre = @version.split(".", 4)
define
end
def define
directory "#{root}/pkg"
(FRAMEWORKS + ["rails"]).each do |framework|
namespace framework do
task :clean do
Dir.chdir(root) do
rm_f gem_path(framework)
end
end
task :update_versions do
update_versions(framework)
end
task gem_path(framework) => [:update_versions, "#{root}/pkg"] do
dir = if framework == "rails"
root
else
root + framework
end
Dir.chdir(dir) do
sh "gem build #{gemspec(framework)} && mv #{gem_file(framework)} #{root}/pkg/"
end
end
task build: [:clean, gem_path(framework)]
task install: :build do
Dir.chdir(root) do
sh "gem install --pre #{gem_path(framework)}"
end
end
task push: :build do
Dir.chdir(root) do
sh "gem push #{gem_path(framework)}#{gem_otp}"
if File.exist?("#{framework}/package.json")
Dir.chdir("#{framework}") do
sh "npm publish --tag #{npm_tag}#{npm_otp}"
end
end
end
end
end
end
desc "Install gems for all projects."
task install: FRAMEWORKS.map { |f| "#{f}:install" } + ["rails:install"]
task :ensure_clean_state do
if tree_dirty?
abort "[ABORTING] `git status` reports a dirty tree. Make sure all changes are committed"
end
unless ENV["SKIP_TAG"] || inexistent_tag?
abort "[ABORTING] `git tag` shows that #{tag} already exists. Has this version already\n"\
" been released? Git tagging can be skipped by setting SKIP_TAG=1"
end
end
namespace :changelog do
task :header do
require "date"
(FRAMEWORKS + ["guides"]).each do |fw|
fname = File.join root, fw, "CHANGELOG.md"
current_contents = File.read(fname)
header = "## Rails #{version} (#{Date.today.strftime('%B %d, %Y')}) ##\n\n"
header += "* No changes.\n\n\n" if current_contents.start_with?("##")
contents = header + current_contents
File.write(fname, contents)
end
end
end
desc "Build gem files for all projects"
task build: FRAMEWORKS.map { |f| "#{f}:build" } + ["rails:build"]
task checksums: :build do
Dir.chdir(root) do
puts
[*FRAMEWORKS, "rails"].each do |fw|
path = gem_path(fw)
sha = ::Digest::SHA256.file(path)
puts "#{sha} #{path}"
end
puts
end
end
task :bundle do
sh "bundle check"
end
desc "Prepare the release"
task prep_release: %w(ensure_clean_state changelog:header build bundle)
task :check_gh_client do
sh "gh auth status" do |ok, res|
unless ok
raise "GitHub CLI is not logged in. Please run `gh auth login` to log in."
end
end
default_repo = `git config --local --get-regexp '\.gh-resolved$'`.strip
if !$?.success? || default_repo.empty?
raise "GitHub CLI does not have a default repo configured. Please run `gh repo set-default rails/rails`"
end
end
task :commit do
Dir.chdir(root) do
unless `git status -s`.strip.empty?
File.open("pkg/commit_message.txt", "w") do |f|
f.puts "# Preparing for #{version} release\n"
f.puts
f.puts "# UNCOMMENT THE LINE ABOVE TO APPROVE THIS COMMIT"
end
sh "git add . && git commit --verbose --template=pkg/commit_message.txt"
rm_f "pkg/commit_message.txt"
end
end
end
task :tag do
sh "git push"
sh "git tag -s -m '#{tag} release' #{tag}"
sh "git push --tags"
end
desc "Create GitHub release"
task create_release: :check_gh_client do
Dir.chdir(root) do
File.write("pkg/#{version}.md", release_notes)
sh "gh release create --verify-tag #{tag} -t #{version} -F pkg/#{version}.md --draft#{pre_release? ? " --prerelease" : ""}"
end
end
desc "Release all gems and create a tag"
task release: %w(check_gh_client prep_release commit tag create_release)
task pre_push: [:build, :checksums]
desc "Push the gem to rubygems.org and the npm package to npmjs.com"
task push: [:pre_push] + FRAMEWORKS.map { |f| "#{f}:push" } + ["rails:push"]
end
def pre_release?
@pre_release ||= pre && pre.match?(/rc|beta|alpha/)
end
def npm_tag
pre_release? ? "pre" : "latest"
end
# This "npm-ifies" the current version number
# With npm, versions such as "5.0.0.rc1" or "5.0.0.beta1.1" are not compliant with its
# versioning system, so they must be transformed to "5.0.0-rc1" and "5.0.0-beta1-1" respectively.
# "5.0.0" --> "5.0.0"
# "5.0.1" --> "5.0.100"
# "5.0.0.1" --> "5.0.1"
# "5.0.1.1" --> "5.0.101"
# "5.0.0.rc1" --> "5.0.0-rc1"
# "5.0.0.beta1.1" --> "5.0.0-beta1-1"
def npm_version
@npm_version ||= begin
if pre_release?
pre_release = pre.tr(".", "-")
npm_pre = 0
else
npm_pre = pre.to_i
pre_release = nil
end
"#{major}.#{minor}.#{(tiny.to_i * 100) + npm_pre}#{pre_release ? "-#{pre_release}" : ""}"
end
end
def gem_path(framework)
"pkg/#{gem_file(framework)}"
end
def gem_file(framework)
"#{framework}-#{version}.gem"
end
def gemspec(framework)
"#{framework}.gemspec"
end
def update_versions(framework)
return if framework == "rails"
Dir.chdir(root) do
glob = "#{framework}/lib/*/gem_version.rb"
file = Dir[glob].first
ruby = File.read(file)
ruby.gsub!(/^(\s*)MAJOR(\s*)= .*?$/, "\\1MAJOR = #{major}")
raise "Could not insert MAJOR in #{file}" unless $1
ruby.gsub!(/^(\s*)MINOR(\s*)= .*?$/, "\\1MINOR = #{minor}")
raise "Could not insert MINOR in #{file}" unless $1
ruby.gsub!(/^(\s*)TINY(\s*)= .*?$/, "\\1TINY = #{tiny}")
raise "Could not insert TINY in #{file}" unless $1
ruby.gsub!(/^(\s*)PRE(\s*)= .*?$/, "\\1PRE = #{pre.inspect}")
raise "Could not insert PRE in #{file}" unless $1
File.open(file, "w") { |f| f.write ruby }
package_json = "#{framework}/package.json"
if File.exist?(package_json) && JSON.parse(File.read(package_json))["version"] != npm_version
Dir.chdir("#{framework}") do
if sh("which npm > /dev/null 2>&1", verbose: false)
sh "npm version #{npm_version} --no-git-tag-version > /dev/null 2>&1", verbose: false
else
raise "You must have npm installed to release Rails."
end
end
end
end
end
def release_notes
release_notes = +""
(FRAMEWORKS + ["guides"]).each do |framework|
release_notes << "## #{framework_name(framework)}\n"
file_name = File.join root, framework, "CHANGELOG.md"
contents = File.readlines file_name
contents.shift # Remove the header
changes = []
until end_of_notes?(contents) || contents.empty?
changes << contents.shift
end
release_notes << changes.join
end
release_notes
end
def framework_name(framework)
framework.split(/(?<=active|action)/).map(&:capitalize).join(" ")
end
private
FILES_TO_IGNORE = %w(
RAILS_VERSION
CHANGELOG
Gemfile.lock
package.json
gem_version.rb
tasks/release.rb
releaser.rb
yarn.lock
)
def tree_dirty?
!`git status -s | grep -v '#{FILES_TO_IGNORE.join("\\|")}'`.strip.empty?
end
def inexistent_tag?
`git tag | grep '^#{tag}$'`.strip.empty?
end
def npm_otp
" --otp " + ykman("npmjs.com")
rescue
" --provenance --access public"
end
def gem_otp
" --otp " + ykman("rubygems.org")
rescue
""
end
def ykman(service)
`ykman oath accounts code -s #{service}`.chomp
end
def end_of_notes?(contents)
line = contents.first
line =~ /^## Rails \d+\.\d+\.\d+.*$/ ||
line =~ /^Please check.*for previous changes\.$/ ||
contents.empty?
end
end
|