Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a 'Changelog' link on rubygems.org/gems/diff-lcs #92

Merged

Conversation

mark-young-atg
Copy link
Contributor

By providing a 'changelog_uri' in the metadata of the gemspec a 'Changelog' link will be shown on https://rubygems.org/gems/diff-lcs which makes it quick and easy for someone to check on the changes introduced with a new version.

Details of this functionality can be found on https://guides.rubygems.org/specification-reference/

@halostatue
Copy link
Owner

diff-ics uses Hoe for release management. Modifying the .gemspec will not work, but should be modified in the spec block in the Rakefile

By providing a 'changelog_uri' in the metadata of the gemspec a
'Changelog' link will be shown on https://rubygems.org/gems/diff-lcs
which makes it quick and easy for someone to check on the changes
introduced with a new version.

Details of this functionality can be found on https://guides.rubygems.org/specification-reference/
@mark-young-atg mark-young-atg force-pushed the provide_changelog_link_on_rubygems branch from 82aa339 to 58428a6 Compare February 2, 2024 16:15
@mark-young-atg
Copy link
Contributor Author

Thanks @halostatue, I've modified the commit. Does that look right to you now?

@halostatue
Copy link
Owner

If you could apply this patch, we can get this merged:

diff --git i/Contributing.md w/Contributing.md
index 72fb5e11285c..fdf0f9ad0c8d 100644
--- i/Contributing.md
+++ w/Contributing.md
@@ -101,6 +101,7 @@ Thanks to everyone else who has contributed code or bug reports to Diff::LCS:
 - Koichi Ito
 - Mark Friedgan
 - Masato Nakamura
+- Mark Young
 - Michael Granger
 - Myron Marston
 - Nicolas Leger
diff --git i/History.md w/History.md
index 14f8540a70b3..89a9b36f6c76 100644
--- i/History.md
+++ w/History.md
@@ -1,5 +1,9 @@
 # History
 
+## NEXT / YYYY-MM-DD
+
+- Mark Young added a Changelog link to the RubyGems metadata. [#92][]
+
 ## 1.5.1 / 2024-01-31
 
 - Peter Goldstein updated CI configuration to add Ruby 3.1 and Masato Nakamura
@@ -422,6 +426,7 @@
 [#89]: https://github.com/halostatue/diff-lcs/pull/89
 [#90]: https://github.com/halostatue/diff-lcs/pull/90
 [#91]: https://github.com/halostatue/diff-lcs/issues/91
+[#92]: https://github.com/halostatue/diff-lcs/pull/92
 [rspec/rspec-expectations#200]: https://github.com/rspec/rspec-expectations/pull/200
 [rspec/rspec-expectations#219]: https://github.com/rspec/rspec-expectations/issues/219
 [rspec/rspec-expectations#238]: https://github.com/rspec/rspec-expectations/issues/238

I won't be doing a release just for this, but it will be nice to have in the next release.

@mark-young-atg
Copy link
Contributor Author

Thanks very much for your help and patience @halostatue
I absolutely agree, making a release for this would be very self referential, but it'll be nice to have when the next release goes out. 👍

@mark-young-atg mark-young-atg force-pushed the provide_changelog_link_on_rubygems branch from 48251b9 to 403d257 Compare February 2, 2024 16:47
@halostatue halostatue enabled auto-merge (rebase) February 2, 2024 18:13
@halostatue halostatue merged commit 1086992 into halostatue:main Feb 2, 2024
32 of 33 checks passed
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