Permalink
Browse files

Fix release task now that NPM is part of the build

Note: this commit looks super weird becuase git. I'm moving the entire
NPM section to the part where we actually push the gems/npm package for
the reasons below. That's not how the git diff looks though.

When we release Rails we run `rake prep_release` which calls
`update_versions`. This was updating the NPM version as well. But when we
would later run `rake install` to test the installed gem
`update_versions` gets called again which causes the install to fail
because NPM sees the version is the same as the last run and refuses to
continue. If you forget to stash this will then cause the push to
RubyGems to fail because `update_versions` is called again and then NPM
will not continue because it thinks the version hasn't been changed even
though it has.

The correct solution would be to not update the NPM verion if it matches
the version already in the file but after an hour I could not find a
simple way to use NPM to read the current version. Honestly that's not
the best way to do it either because say you forget to update something
else and then the script thinks it's already been updated.

With that in mind I think the best solution is to not update the NPM
version until right before we are going to push to NPM because then that
won't cause the push to RubyGems to fail.
  • Loading branch information...
eileencodes committed Jul 1, 2016
1 parent 49a881e commit 297e262035ce9dce9c33f8bebc778f36760a5e40
Showing with 22 additions and 18 deletions.
  1. +22 −18 tasks/release.rb
View
@@ -43,7 +43,28 @@
raise "Could not insert PRE in #{file}" unless $1
File.open(file, 'w') { |f| f.write ruby }
end
task gem => %w(update_versions pkg) do
cmd = ""
cmd << "cd #{framework} && " unless framework == "rails"
cmd << "bundle exec rake package && " unless framework == "rails"
cmd << "gem build #{gemspec} && mv #{framework}-#{version}.gem #{root}/pkg/"
sh cmd
end
task :build => [:clean, gem]
task :install => :build do
sh "gem install --pre #{gem}"
end
task :push => :build do
sh "gem push #{gem}"
# When running the release task we usually run build first to check that the gem works properly.
# NPM will refuse to publish or rebuild the gem if the version is changed when the Rails gem
# versions are changed. This then causes the gem push to fail. Because of this we need to update
# the version and publish at the same time.
if File.exist?("#{framework}/package.json")
Dir.chdir("#{framework}") do
# This "npm-ifies" the current version
@@ -68,30 +89,13 @@
# Check if npm is installed, and raise an error if not
if sh 'which npm'
sh "npm version #{version} --no-git-tag-version"
sh "npm publish"
else
raise 'You must have npm installed to release Rails.'
end
end
end
end
task gem => %w(update_versions pkg) do
cmd = ""
cmd << "cd #{framework} && " unless framework == "rails"
cmd << "bundle exec rake package && " unless framework == "rails"
cmd << "gem build #{gemspec} && mv #{framework}-#{version}.gem #{root}/pkg/"
sh cmd
end
task :build => [:clean, gem]
task :install => :build do
sh "gem install --pre #{gem}"
end
task :push => :build do
sh "gem push #{gem}"
sh "npm publish" if File.exist?("#{framework}/package.json")
end
end
end

2 comments on commit 297e262

@eileencodes

This comment has been minimized.

Show comment
Hide comment
@eileencodes

eileencodes Jul 1, 2016

Member

cc/ @rafaelfranca I believe this will fix the issue I had with releasing to RubyGems and NPM. We should just update the version and push to NPM at the same time. Note the diff looks super weird but what I did was move the entire NPM section down to under gem push.

But now im wondering if this will leave a dirty tree and rake all:push will fail 😕

Member

eileencodes replied Jul 1, 2016

cc/ @rafaelfranca I believe this will fix the issue I had with releasing to RubyGems and NPM. We should just update the version and push to NPM at the same time. Note the diff looks super weird but what I did was move the entire NPM section down to under gem push.

But now im wondering if this will leave a dirty tree and rake all:push will fail 😕

@rafaelfranca

This comment has been minimized.

Show comment
Hide comment
@rafaelfranca

rafaelfranca Jul 2, 2016

Member

I think it is fine for now. Let's test in the next release and see if it will leave a dirty tree. Thanks

Member

rafaelfranca replied Jul 2, 2016

I think it is fine for now. Let's test in the next release and see if it will leave a dirty tree. Thanks

Please sign in to comment.