Add change log links to gem page by kbrock · Pull Request #1553 · rubygems/rubygems.org

kbrock · 2017-01-26T13:48:45Z

Alternative to #728

This reads the changelog uri from the metadata without requiring changing the Linkset table.

The core of the change is in Links:58

It dynamically generates methods for each of the link attributes.
The value is read from the metadata. If it is not present, it falls back to the value in the Linkset.
For changelog (and future uri values), it is not defined in linkset, so a try is used to be flexible here.

/cc @olivierlacan sorry it took me so long.

olivierlacan · 2017-01-26T15:16:49Z

@kbrock I knew there was something weird about that old migration!

olivierlacan · 2017-01-26T15:17:45Z

I think the tests I had on #728 were pretty thorough, want me to add them back?

kbrock · 2017-01-26T15:20:12Z

@olivierlacan refresh - linkset does not define changelog. That is the only test I saw. I added them more of an intergration test on the json / xml api.

need tests around view?
you can cherry-pick / steal this stuff back. I rebased on master

kbrock · 2017-01-26T15:25:32Z

@olivierlacan whoa. ok, we'll push forward here.

the i18n failed test are curious. I thought it was defined. maybe I'm misspelling something
the rubocop is easy to fix (was hoping to avoid because this PR looks super small/simple w/o it)
the brakeman issues look like a whole separate PR. sigh

Also, do you have a gem w/ changelog metadata you tested?
I'll put one together and figure out how to load into my db locally. Sorry I haven't introduced in the wild yet :( (I even have a gem w/ no changelog :( )

dwradcliffe · 2017-02-03T03:12:34Z

@kbrock you'll need to add the locale changes to every language. If you aren't able to translate them (that's totally fine!) you can just add the key with no value.

kbrock · 2017-02-03T15:25:03Z

@dwradcliffe thanks so much

olleolleolle · 2017-02-04T15:24:53Z


  # define getters for each of the uris (both short `home` or long `homepage_uri` versions)
  # don't define for download_uri since it has special logic and is already defined
+  # using a try becaue linkset does not define all the uri attributes


Typo becaue => because

thnx. fixed

olivierlacan · 2017-03-06T19:17:33Z

@kbrock Other than translations, for which I offer http://keepachangelog.com/ as a guide, do we have any other blockers?

olivierlacan · 2017-03-06T19:15:33Z

    attributes:
      linkset:
        bugs: Bug Tracker URL
+        changelog:


Based on http://keepachangelog.com/de/0.3.0/ you can use Changelog here too.

olivierlacan · 2017-03-06T19:16:17Z

      links:
        badge: Badge
        bugs: Bug Tracker
+        changelog: Change Log


I'd suggest sticking to one-word Changelog. We've had many discussions over on http://keepachangelog.com/ about this and it seems like the most correct in-domain (software) spelling.

olivierlacan · 2017-03-06T19:16:41Z

    attributes:
      linkset:
        bugs: URL del registro de Bugs
+        changelog:


Same here, Changelog should be fine. http://keepachangelog.com/es-ES/0.3.0/

indirect · 2017-03-08T06:30:33Z

@kbrock this looks good to me as soon as the last comments from @olivierlacan are addressed. 👍

sonalkr132 · 2017-03-08T08:55:41Z

+    'wiki' => 'wiki_uri',
+    'mail' => 'mailing_list_uri',
+    'bugs' => 'bug_tracker_uri',
    'download' => 'download_uri'


Can we please keep => aligned?

@jaymcgavren

This adds a new changelog column to the displays that change log alongside the existing linkset links. I originally wrote this with @jaymcgavren but had to recommit because of really bad rebase clusterpoop. I hope you forgive me, Jay.

@olivierlacan

This takes changelog out of the Links table Tried to keep as much of the commits from @olivierlacan and @jaymcgavren as possible.

kbrock · 2017-03-08T18:00:54Z

Thanks @olivierlacan - never occurred to me to look at the source of all of this :(
I went through a few languages and didn't find any special names for changelog.
Let me know if I missed something

kbrock · 2017-03-09T21:02:47Z

Thanks @sonalkr132 I didn't see that warning when running rubocop locally.

Let me know if you have any other similar comments.

olivierlacan · 2017-03-28T11:57:19Z

@sonalkr132 @kbrock Are we good to go? Or do we want to find more translations for Changelog before we merge this?

sonalkr132 · 2017-03-29T06:43:04Z

LGTM 👍 We will merge as soon as we can.

olivierlacan · 2017-04-03T19:47:55Z

@kbrock Curious if you think we should update http://guides.rubygems.org/specification-reference/#metadata with a canonical list of metadata that rubygems.org currently accepts or just a straight up link to Link for now.

Ref: ruby#1834 rubygems/rubygems.org#1553

sonalkr132 · 2017-04-03T20:01:23Z

@olivierlacan Check: ruby/rubygems#1885. guide will be update when we regenerate the doc.

olivierlacan · 2017-04-03T20:26:05Z

@sonalkr132 Perfect, thank you!

Add changelog to metadata validation Ref: #1834 rubygems/rubygems.org#1553 # Description: We need to validate changelog link during `gem build`. # Tasks: - [x] Describe the problem / feature - [ ] Write tests - [x] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md).

kbrock force-pushed the add_changelog_link branch 2 times, most recently from 54e96bf to 3aab172 Compare January 26, 2017 15:14

kbrock changed the title ~~[WIP] Add change log links to gem page~~ Add change log links to gem page Jan 26, 2017

olivierlacan mentioned this pull request Jan 26, 2017

Add change log links to gem page #728

Closed

sonalkr132 added the needs-more-work label Jan 31, 2017

olleolleolle reviewed Feb 4, 2017

View reviewed changes

kbrock force-pushed the add_changelog_link branch 2 times, most recently from b21c36d to efec876 Compare February 7, 2017 16:04

sonalkr132 added needs-review and removed needs-more-work labels Feb 7, 2017

olivierlacan reviewed Mar 6, 2017

View reviewed changes

sonalkr132 reviewed Mar 8, 2017

View reviewed changes

olivierlacan and others added 2 commits March 8, 2017 12:41

Add change log links to gem page

65acac2

This adds a new changelog column to the displays that change log alongside the existing linkset links. I originally wrote this with @jaymcgavren but had to recommit because of really bad rebase clusterpoop. I hope you forgive me, Jay.

Add change log links to gem page w/o table change

06996e6

This takes changelog out of the Links table Tried to keep as much of the commits from @olivierlacan and @jaymcgavren as possible.

kbrock force-pushed the add_changelog_link branch from efec876 to 4210796 Compare March 8, 2017 17:56

fix links::LINK hash spacing for rubocop

1aa755c

kbrock force-pushed the add_changelog_link branch from 4210796 to 1aa755c Compare March 8, 2017 18:02

sonalkr132 approved these changes Mar 10, 2017

View reviewed changes

sonalkr132 added the needs-more-merging label Mar 29, 2017

sonalkr132 removed the needs-review label Mar 29, 2017

sonalkr132 merged commit 184a774 into rubygems:master Apr 3, 2017

rubygems-deployer deployed to staging April 3, 2017 19:33 Active

sonalkr132 added a commit to sonalkr132/rubygems that referenced this pull request Apr 3, 2017

Add changelog to metadata validation

aea8178

Ref: ruby#1834 rubygems/rubygems.org#1553

sonalkr132 mentioned this pull request Apr 3, 2017

Add changelog to metadata validation ruby/rubygems#1885

Merged

4 tasks

kbrock deleted the add_changelog_link branch April 3, 2017 20:09

jvanbaarsen mentioned this pull request Apr 8, 2017

Link to a change log from gem page #578

Closed

dwradcliffe deployed to production April 16, 2017 21:49 Active

dwradcliffe removed the needs-more-merging label Apr 16, 2017

andrew mentioned this pull request May 8, 2017

Community Action Lists librariesio/libraries.io#1416

Closed

MaximeD mentioned this pull request Sep 17, 2023

CHANGE to use changelog uri from rubygems metadata MaximeD/gem_updater#171

Merged

Uh oh!

Conversation

kbrock commented Jan 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

olivierlacan commented Jan 26, 2017

Uh oh!

olivierlacan commented Jan 26, 2017

Uh oh!

kbrock commented Jan 26, 2017

Uh oh!

kbrock commented Jan 26, 2017

Uh oh!

dwradcliffe commented Feb 3, 2017

Uh oh!

kbrock commented Feb 3, 2017

Uh oh!

olleolleolle Feb 4, 2017

Choose a reason for hiding this comment

Uh oh!

kbrock Feb 6, 2017

Choose a reason for hiding this comment

Uh oh!

olivierlacan commented Mar 6, 2017

Uh oh!

olivierlacan Mar 6, 2017

Choose a reason for hiding this comment

Uh oh!

olivierlacan Mar 6, 2017

Choose a reason for hiding this comment

Uh oh!

olivierlacan Mar 6, 2017

Choose a reason for hiding this comment

Uh oh!

indirect commented Mar 8, 2017

Uh oh!

sonalkr132 Mar 8, 2017

Choose a reason for hiding this comment

Uh oh!

kbrock commented Mar 8, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kbrock commented Mar 9, 2017

Uh oh!

olivierlacan commented Mar 28, 2017

Uh oh!

sonalkr132 commented Mar 29, 2017

Uh oh!

olivierlacan commented Apr 3, 2017

Uh oh!

sonalkr132 commented Apr 3, 2017

Uh oh!

olivierlacan commented Apr 3, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

kbrock commented Jan 26, 2017 •

edited

Loading

kbrock commented Mar 8, 2017 •

edited

Loading