alphagov / tech-docs-gem

Gem to distribute the tech docs project
https://tdt-documentation.london.cloudapps.digital/
MIT License
15 stars 38 forks source link

Add tests for Ruby 3.x support #328

Closed lfdebrux closed 1 year ago

lfdebrux commented 1 year ago

What’s changed

Ruby 2.7 has reached end of life, our users want to be able to use the latest stable versions of Ruby. Middleman recently released support for Ruby 3.1 and greater [1], so this gem should be able to work with Ruby 3, but to make sure we should update our test workflows. A few tweaks were needed, including updating the linter, but nothing major.

At the same time we also update the version of Node.js used for the tests, as Node.js 14 reached end of life a while ago as well. I also threw in a fix for the Haml issues (#318), as the tests wouldn't run otherwise.

Identifying a user need

Closes #327.

lfdebrux commented 1 year ago

Looks good, and CI seems happy. Great to have node upgraded too.

we're removing the .ruby-version file, interested in the thinking there? Whilst there's no Gemfile here with the usual referencing of that file, the ruby-version does have some general use, no?

Don't both Rbenv and RVM use that file to try and help setup a devs ruby version?

Might be a gap in my knowledge as I mostly work on applications not gems 🤔

Yeah, totally, it is useful, the only reason I removed it is to avoid duplication of the version numbers... it's hard to remember to update in multiple places, and as the ruby version file doesn't support short version numbers it's a double pain to keep up to date. I'm trying to keep maintenance down basically.

jfharden commented 1 year ago

Removing the .ruby-version file has broken the publishing to rubygems step: https://github.com/alphagov/tech-docs-gem/actions/runs/5023630866/jobs/9008447497

jfharden commented 1 year ago

I've created a new issue for it: https://github.com/alphagov/tech-docs-gem/issues/329

lfdebrux commented 1 year ago

Ah, good spot @jfharden, thanks for flagging. I hadn't noticed as I hadn't been trying to publish these changes.