Improve gem deployment #2152

zephraph · 2022-03-02T22:40:05Z

What Changed

Updates writeNewVersion for the gem plugin to also bump the version in the lock file and go ahead and commit it. Also refactors the gem plugin tests not to mock out fs.readFile, etc in favor of using mock-fs.

Why

I've been hitting an issue (see below) that prevents me from deploying today where bundle exec rake build fails b/c the lock file has changed. It seems like this is some strict mode that is utilized in the GitHub actions environment. In the plugin we previously held off on committing the version change b/c the build would update the lockfile. This is basically b/c it's updating the package version that's also referenced in the lockfile. I went ahead and added that as a part of the writeNewVersion function. The benefit here is that it should be clean in an expected way when bundle exec rake build runs. If it's not it really is a problem that would need to be addressed by the gem author.

Error: Running command 'bundle' with args [exec, rake, build] failed

bundler: failed to load command: rake (/home/runner/work/asciidoctor-mermaid/asciidoctor-mermaid/vendor/bundle/ruby/2.7.0/bin/rake)
/opt/hostedtoolcache/Ruby/2.7.5/x64/lib/ruby/gems/2.7.0/gems/bundler-2.3.8/lib/bundler/definition.rb:397:in `ensure_equivalent_gemfile_and_lockfile': You are trying to install in deployment mode after changing (Bundler::ProductionError)
your Gemfile. Run `bundle install` elsewhere and add the
updated Gemfile.lock to version control.

Todo:

Add tests
Add docs

Change Type

Indicate the type of change your pull request is:

documentation
patch
minor
major

🐤 Download canary assets:

auto-linux--canary.2152.25627.gz
auto-macos--canary.2152.25627.gz
auto-win.exe--canary.2152.25627.gz

📦 Published PR as canary version: under canary scope @auto-canary@10.34.0--canary.2152.25627.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@10.34.0--canary.2152.25627.0
npm install @auto-canary/auto@10.34.0--canary.2152.25627.0
npm install @auto-canary/core@10.34.0--canary.2152.25627.0
npm install @auto-canary/package-json-utils@10.34.0--canary.2152.25627.0
npm install @auto-canary/all-contributors@10.34.0--canary.2152.25627.0
npm install @auto-canary/brew@10.34.0--canary.2152.25627.0
npm install @auto-canary/chrome@10.34.0--canary.2152.25627.0
npm install @auto-canary/cocoapods@10.34.0--canary.2152.25627.0
npm install @auto-canary/conventional-commits@10.34.0--canary.2152.25627.0
npm install @auto-canary/crates@10.34.0--canary.2152.25627.0
npm install @auto-canary/docker@10.34.0--canary.2152.25627.0
npm install @auto-canary/exec@10.34.0--canary.2152.25627.0
npm install @auto-canary/first-time-contributor@10.34.0--canary.2152.25627.0
npm install @auto-canary/gem@10.34.0--canary.2152.25627.0
npm install @auto-canary/gh-pages@10.34.0--canary.2152.25627.0
npm install @auto-canary/git-tag@10.34.0--canary.2152.25627.0
npm install @auto-canary/gradle@10.34.0--canary.2152.25627.0
npm install @auto-canary/jira@10.34.0--canary.2152.25627.0
npm install @auto-canary/magic-zero@10.34.0--canary.2152.25627.0
npm install @auto-canary/maven@10.34.0--canary.2152.25627.0
npm install @auto-canary/microsoft-teams@10.34.0--canary.2152.25627.0
npm install @auto-canary/npm@10.34.0--canary.2152.25627.0
npm install @auto-canary/omit-commits@10.34.0--canary.2152.25627.0
npm install @auto-canary/omit-release-notes@10.34.0--canary.2152.25627.0
npm install @auto-canary/pr-body-labels@10.34.0--canary.2152.25627.0
npm install @auto-canary/released@10.34.0--canary.2152.25627.0
npm install @auto-canary/s3@10.34.0--canary.2152.25627.0
npm install @auto-canary/sbt@10.34.0--canary.2152.25627.0
npm install @auto-canary/slack@10.34.0--canary.2152.25627.0
npm install @auto-canary/twitter@10.34.0--canary.2152.25627.0
npm install @auto-canary/upload-assets@10.34.0--canary.2152.25627.0
npm install @auto-canary/vscode@10.34.0--canary.2152.25627.0
# or 
yarn add @auto-canary/bot-list@10.34.0--canary.2152.25627.0
yarn add @auto-canary/auto@10.34.0--canary.2152.25627.0
yarn add @auto-canary/core@10.34.0--canary.2152.25627.0
yarn add @auto-canary/package-json-utils@10.34.0--canary.2152.25627.0
yarn add @auto-canary/all-contributors@10.34.0--canary.2152.25627.0
yarn add @auto-canary/brew@10.34.0--canary.2152.25627.0
yarn add @auto-canary/chrome@10.34.0--canary.2152.25627.0
yarn add @auto-canary/cocoapods@10.34.0--canary.2152.25627.0
yarn add @auto-canary/conventional-commits@10.34.0--canary.2152.25627.0
yarn add @auto-canary/crates@10.34.0--canary.2152.25627.0
yarn add @auto-canary/docker@10.34.0--canary.2152.25627.0
yarn add @auto-canary/exec@10.34.0--canary.2152.25627.0
yarn add @auto-canary/first-time-contributor@10.34.0--canary.2152.25627.0
yarn add @auto-canary/gem@10.34.0--canary.2152.25627.0
yarn add @auto-canary/gh-pages@10.34.0--canary.2152.25627.0
yarn add @auto-canary/git-tag@10.34.0--canary.2152.25627.0
yarn add @auto-canary/gradle@10.34.0--canary.2152.25627.0
yarn add @auto-canary/jira@10.34.0--canary.2152.25627.0
yarn add @auto-canary/magic-zero@10.34.0--canary.2152.25627.0
yarn add @auto-canary/maven@10.34.0--canary.2152.25627.0
yarn add @auto-canary/microsoft-teams@10.34.0--canary.2152.25627.0
yarn add @auto-canary/npm@10.34.0--canary.2152.25627.0
yarn add @auto-canary/omit-commits@10.34.0--canary.2152.25627.0
yarn add @auto-canary/omit-release-notes@10.34.0--canary.2152.25627.0
yarn add @auto-canary/pr-body-labels@10.34.0--canary.2152.25627.0
yarn add @auto-canary/released@10.34.0--canary.2152.25627.0
yarn add @auto-canary/s3@10.34.0--canary.2152.25627.0
yarn add @auto-canary/sbt@10.34.0--canary.2152.25627.0
yarn add @auto-canary/slack@10.34.0--canary.2152.25627.0
yarn add @auto-canary/twitter@10.34.0--canary.2152.25627.0
yarn add @auto-canary/upload-assets@10.34.0--canary.2152.25627.0
yarn add @auto-canary/vscode@10.34.0--canary.2152.25627.0

codecov · 2022-03-02T23:01:16Z

Codecov Report

Merging #2152 (4c667df) into main (b63ef24) will increase coverage by 0.09%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2152      +/-   ##
==========================================
+ Coverage   80.21%   80.30%   +0.09%     
==========================================
  Files          66       66              
  Lines        5422     5423       +1     
  Branches     1268     1270       +2     
==========================================
+ Hits         4349     4355       +6     
+ Misses        710      708       -2     
+ Partials      363      360       -3

Impacted Files	Coverage Δ
plugins/gem/src/index.ts	`83.33% <100.00%> (+3.94%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f4ac2d4...4c667df. Read the comment docs.

zephraph · 2022-03-05T08:37:40Z

I validated this latest version worked by publishing https://rubygems.org/gems/asciidoctor-mermaid. The repo isn't public yet, but I'll open it up soon.

intuit-svc · 2022-03-05T08:46:01Z

🚀 PR was released in v10.34.0 🚀

zephraph added 3 commits March 2, 2022 14:18

Refactor gem tests

b5cd7b8

Update mockfs to fix osx issues

d230876

Update lockfile when writing new version

8651035

intuit-svc added the minor Increment the minor version when merged label Mar 2, 2022

Appease the lint gods

bd6ed94

zephraph force-pushed the improve-gem-deployment branch from 4dc45cd to bd6ed94 Compare March 2, 2022 22:53

zephraph requested a review from hipstersmoothie March 2, 2022 22:56

hipstersmoothie approved these changes Mar 4, 2022

View reviewed changes

zephraph added 3 commits March 4, 2022 23:43

Resolve issue where lockfile wasn't being updated

b2aa7a2

Add test for throwing without name

fae1731

Merge branch 'main' into improve-gem-deployment

4c667df

zephraph merged commit b1f048d into main Mar 5, 2022

zephraph deleted the improve-gem-deployment branch March 5, 2022 08:37

intuit-svc added the released This issue/pull request has been released. label Mar 5, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve gem deployment #2152

Improve gem deployment #2152

zephraph commented Mar 2, 2022 •

edited by intuit-svc

codecov bot commented Mar 2, 2022 •

edited

zephraph commented Mar 5, 2022

intuit-svc commented Mar 5, 2022

Improve gem deployment #2152

Improve gem deployment #2152

Conversation

zephraph commented Mar 2, 2022 • edited by intuit-svc

What Changed

Why

Change Type

codecov bot commented Mar 2, 2022 • edited

Codecov Report

zephraph commented Mar 5, 2022

intuit-svc commented Mar 5, 2022

zephraph commented Mar 2, 2022 •

edited by intuit-svc

codecov bot commented Mar 2, 2022 •

edited