Skip to content

Fill in gem metadata and refresh README - #20

Open
benrfairless wants to merge 2 commits into
chore/increase-test-coveragefrom
chore/update-gem-metadata
Open

Fill in gem metadata and refresh README#20
benrfairless wants to merge 2 commits into
chore/increase-test-coveragefrom
chore/update-gem-metadata

Conversation

@benrfairless

@benrfairless benrfairless commented Aug 12, 2026

Copy link
Copy Markdown
Member

Description

Fixes the gem's metadata and documentation:

  • Homepage — currently empty on rubygems.org — set to this repository, plus homepage_uri, source_code_uri, bug_tracker_uri and changelog_uri metadata
  • rubygems_mfa_required = "true" so manual pushes to RubyGems require MFA (the matching RuboCop todo exclusion is removed)
  • Accurate summary and description mentioning morph.io and what the CLI actually does
  • New CHANGELOG.md in Keep a Changelog format, covering the unreleased modernisation work and linked from the gem metadata
  • README rewritten: working gem-version and CI badges, accurate supported Ruby (>= 3.2, replacing "Ruby >= 1.9"), install/usage docs including where the API key is stored, development instructions, contributing section linking the OAF contributing guide, and a license section

Motivation and Context

The rubygems.org listing for morph-cli has no homepage or source link, making the gem hard to trace back to this repo, and the README claimed Ruby 1.9 support. Part 4 of the modernisation series.

How Has This Been Tested?

  • Checked affected area manually on my own / staging system
  • Ran automated tests on my own system
  • Confirmed it passed the GitHub actions tests

bundle exec rake build then inspected the built gem with gem spec to confirm homepage and metadata are set; bundle exec rspec (29 examples, 0 failures) and bundle exec rubocop (no offenses) on Ruby 3.2.2.

Screenshots (if appropriate):

N/A

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Part 4 of the 5-PR modernisation series. Stacked on #19 (base branch chore/increase-test-coverage); GitHub will retarget as the stack merges.

Assisted-by: opencode/anthropic.claude-fable-5

@benrfairless benrfairless self-assigned this Aug 12, 2026
@benrfairless
benrfairless marked this pull request as ready for review August 12, 2026 01:56
@benrfairless
benrfairless force-pushed the chore/update-gem-metadata branch from d63ae51 to 2c8a234 Compare August 12, 2026 03:00
@benrfairless
benrfairless requested a review from a team as a code owner August 12, 2026 03:00

@ianheggie-oaf ianheggie-oaf left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved - LGTM at a glance

@benrfairless
benrfairless force-pushed the chore/update-gem-metadata branch from 2c8a234 to 35d01fd Compare August 12, 2026 03:51
The gem had an empty homepage on rubygems.org and no metadata URIs,
so the rubygems.org page linked to nothing useful.

- Set homepage and homepage_uri/source_code_uri/bug_tracker_uri/
  changelog_uri metadata pointing at this repository
- Require MFA for manual pushes to RubyGems
  (rubygems_mfa_required=true) and drop the RuboCop todo entry that
  was excusing its absence
- Give the gem an accurate summary and description that mention
  morph.io and what the CLI actually does
- Add a CHANGELOG.md (Keep a Changelog format) covering the
  unreleased modernisation work
- Rewrite the README: working badges, accurate supported Ruby
  (>= 3.3), install/usage including where the API key is stored,
  development instructions, contributing section pointing at the
  OpenAustralia Foundation contributing guide, and a license section

Assisted-by: opencode/anthropic.claude-fable-5
Signed-off-by: Ben Fairless <ben@oaf.org.au>
Assisted-by: Claude Code:anthropic.claude-fable-5
@benrfairless
benrfairless force-pushed the chore/update-gem-metadata branch from 35d01fd to 82031b9 Compare August 13, 2026 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants