Skip to content

Add change log links to gem page#728

Closed
olivierlacan wants to merge 3 commits into
rubygems:masterfrom
olivierlacan:add-changelog-link
Closed

Add change log links to gem page#728
olivierlacan wants to merge 3 commits into
rubygems:masterfrom
olivierlacan:add-changelog-link

Conversation

@olivierlacan
Copy link
Copy Markdown
Contributor

This adds a new changelog column to the linksets table and displays
that change log alongside the existing linkset links.

image

This is a draft, there may be tests we haven't thought of updating with @jaymcgavren but we will if necessary.

Fixes #578

@olivierlacan olivierlacan force-pushed the add-changelog-link branch 2 times, most recently from fbb1a1e to 517283c Compare November 5, 2014 16:52
@evanphx
Copy link
Copy Markdown
Member

evanphx commented Nov 5, 2014

Where is the changelog value pulled from though? I don't see how it's set.

@olivierlacan
Copy link
Copy Markdown
Contributor Author

@evanphx It's not being pulled from anywhere at the moment since it would need to be a new gemspec key. But there's still this gem edit page I had no idea about: https://github.com/rubygems/rubygems.org/blob/master/app/views/rubygems/edit.html.erb

@dwradcliffe
Copy link
Copy Markdown
Member

Based on the other PRs in progress, it sounds like editing via the website was going to be discouraged. Given that, should this new link only pull from the gemspec? Just a thought.

@olivierlacan
Copy link
Copy Markdown
Contributor Author

@dwradcliffe Sounds like a reasonable thing to do. I was amazed it's possible to override Linkset values, that said I don't think there's an active route for that gem edit page. Could be wrong.

This PR doesn't pull from anything, it's just ready to receive a new key as long as the key is named changelog.

@evanphx
Copy link
Copy Markdown
Member

evanphx commented Nov 5, 2014

@olivierlacan There doesn't need to be a new gemspec key. The code can use the metadata keys. We're generally not adding any new gemspec fields.

@dwradcliffe
Copy link
Copy Markdown
Member

@olivierlacan There is an active route to edit gems (

resources :rubygems, :path => 'gems', :only => [:show, :edit, :update] do
) so that template would be used.

@kbrock
Copy link
Copy Markdown
Contributor

kbrock commented Jan 2, 2015

👍 to adding it to the metadata

@igrep
Copy link
Copy Markdown

igrep commented Jan 3, 2015

👍 I expect this feature to be merged! It'll make much easier to see a new version's change before updating the gem. 🙏

@olivierlacan
Copy link
Copy Markdown
Contributor Author

Makes sense to me. Will update soon.

@kbrock
Copy link
Copy Markdown
Contributor

kbrock commented Jan 8, 2015

@olivierlacan when this merges, can you double check that #724 adds changelog_uri key?

OTOH, if #724 goes through first, I will ping you so you can add the changelog_uri key to the new metadata hash.

@davefp
Copy link
Copy Markdown
Contributor

davefp commented Feb 4, 2015

@olivierlacan As a result of #610 a large chunk of the repo's history was re-written. Please rebase your PR so that it will merge cleanly. Thanks!

(There are further details on the blog: http://blog.rubygems.org/2015/02/01/rewriting-history.html)

@kbrock
Copy link
Copy Markdown
Contributor

kbrock commented Feb 9, 2015

After 724 goes through, I'll rebase this one.

@olivierlacan
Copy link
Copy Markdown
Contributor Author

@kbrock I'm going to entirely re-commit this PR with master so I can make it easily mergeable into #724 when that's done.

@kbrock
Copy link
Copy Markdown
Contributor

kbrock commented Nov 9, 2015

@olivierlacan I was thinking that we would not add changelog in the form. Just read it out of the meta-data.

I think it would be great if the gemspec were the source for all gem metadata. Did you have something similar in mind?

@olivierlacan
Copy link
Copy Markdown
Contributor Author

@kbrock Oh yeah, my bad. I'll nix that.

@olivierlacan
Copy link
Copy Markdown
Contributor Author

@kbrock Just force-pushed a removal of the edit changelog input in the form.

This adds a new changelog column to the linksets table and 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
Copy link
Copy Markdown
Contributor Author

Rebased.

@indirect
Copy link
Copy Markdown

I am 👍 on this, reading a changelog link out of the gemspec metadata hash seems good to me.

@arthurnn
Copy link
Copy Markdown
Member

I am also 👍 on this, however I would like us to finish #1127 first, before adding more links.

@homu
Copy link
Copy Markdown
Contributor

homu commented Mar 8, 2016

☔ The latest upstream changes (presumably #1209) made this pull request unmergeable. Please resolve the merge conflicts.

@dwradcliffe dwradcliffe added this to the Metadata milestone May 26, 2016
@kbrock
Copy link
Copy Markdown
Contributor

kbrock commented Jan 6, 2017

@olivierlacan #1234 merged - will look into the best way of getting this in.

Do you care if there is a field on a form? Or just reading from gemset.metadata[:changelog_uri] is good enough for you?

@olivierlacan
Copy link
Copy Markdown
Contributor Author

olivierlacan commented Jan 7, 2017 via email

@indirect
Copy link
Copy Markdown

👍

My justification for this is that the changelog link is more news-worthy perhaps. Feel free to discuss.
@olivierlacan
Copy link
Copy Markdown
Contributor Author

Closing since we @kbrock made #1553 with no migration required.

@olivierlacan olivierlacan deleted the add-changelog-link branch January 26, 2017 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link to a change log from gem page