Skip to content

Add metadata links to the gemspec#40

Open
tas50 wants to merge 1 commit into
chef:mainfrom
tas50:feat/gemspec-metadata
Open

Add metadata links to the gemspec#40
tas50 wants to merge 1 commit into
chef:mainfrom
tas50:feat/gemspec-metadata

Conversation

@tas50

@tas50 tas50 commented Jun 28, 2026

Copy link
Copy Markdown

Summary

Adds a metadata block to chefspec.gemspec so rubygems.org/gems/chefspec renders the standard sidebar links (source, changelog, issues, docs) instead of just the homepage.

s.metadata = {
  "source_code_uri"   => "https://github.com/chef/chefspec",
  "changelog_uri"     => "https://github.com/chef/chefspec/blob/main/CHANGELOG.md",
  "bug_tracker_uri"   => "https://github.com/chef/chefspec/issues",
  "documentation_uri" => "https://github.com/chef/chefspec/blob/main/README.md",
}

Notes

  • homepage_uri is intentionally omitted — it would duplicate the existing s.homepage and source_code_uri (RubyGems warns when two metadata keys share a URL).
  • rubygems_mfa_required was deliberately left out: it requires an OTP on push and could break the automated Expeditor publish pipeline. That's a maintainer/release-policy decision better made separately.

Testing

  • Gem::Specification.load("chefspec.gemspec").validate → valid, no warnings.
  • cookstyle --chefstyle -c .rubocop.yml chefspec.gemspec → no offenses.

Add a metadata block so RubyGems.org renders sidebar links to the source,
changelog, issue tracker, and documentation. homepage_uri is omitted
since it would duplicate s.homepage and source_code_uri.

Signed-off-by: Tim Smith <tsmith84@proton.me>
@tas50
tas50 requested review from a team and jaymzh as code owners June 28, 2026 05:34
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.

1 participant