Skip to content

Add changelog on the releases page #12796

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

Closed
solracsf opened this issue Dec 8, 2016 · 5 comments
Closed

Add changelog on the releases page #12796

solracsf opened this issue Dec 8, 2016 · 5 comments
Assignees
Labels
Enhancement A feature request for improving phpMyAdmin

Comments

@solracsf
Copy link
Contributor

solracsf commented Dec 8, 2016

It would be helpful if a changelog was added on the releases page after each release.
My 2 cents.

@ibennetch
Copy link
Member

Interesting idea; I like the suggestion.

This probably would mean changing the text of https://www.phpmyadmin.net/downloads/ to something like "Released 2016-12-05, see the release notes for details or the ChangeLog for a complete list of all changes."

In turn, that means either copying ChangeLog along with the compressed distribution files in create-release.sh or generating a link to GitHub such as https://github.com/phpmyadmin/phpmyadmin/blob/RELEASE_4_6_5_1/ChangeLog.

@ibennetch ibennetch added the Enhancement A feature request for improving phpMyAdmin label Dec 8, 2016
@solracsf
Copy link
Contributor Author

solracsf commented Dec 8, 2016

Something like https://github.com/PrestaShop/PrestaShop/releases/tag/1.7.0.1 is the best way, IMO.

It would be more easy to read in links like https://github.com/phpmyadmin/phpmyadmin/releases.atom or in the releases page.

@ibennetch
Copy link
Member

While that helps people who are familiar with GitHub, we have a large number of downloads from direct links on our website and an ideal solution should provide a link to the ChangeLog for them, as well. It may well be a link to the GitHub page, but when implementing a solution we should consider how to generate that link.

nijel added a commit to phpmyadmin/scripts that referenced this issue Dec 13, 2016
See phpmyadmin/phpmyadmin#12796

Signed-off-by: Michal Čihař <michal@cihar.com>
nijel added a commit to phpmyadmin/scripts that referenced this issue Dec 13, 2016
See phpmyadmin/phpmyadmin#12796

Signed-off-by: Michal Čihař <michal@cihar.com>
@nijel
Copy link
Contributor

nijel commented Dec 13, 2016

For now I've added link to release notes on our website and list of issues fixed in given milestone. I know it's additional click, but on the other side this was really simple to implement :-).

nijel added a commit to phpmyadmin/scripts that referenced this issue Feb 13, 2017
See phpmyadmin/phpmyadmin#12796

Signed-off-by: Michal Čihař <michal@cihar.com>
@nijel nijel self-assigned this Feb 13, 2017
@nijel
Copy link
Contributor

nijel commented Feb 13, 2017

I think this is good enough. Especially as the Git snapshots which are there for download are not really good for end users, they should end up on our website anyway.

I'm not sure it's worth of the effort duplicating content we have on our website on GitHub - to fill in release notes and upload files there. Of course this can be scripted, but I see quite a lot more important things to do.

If somebody wants to contribute code to our website to implement sync to GitHub releases, contributions are welcome, see phpmyadmin/website#56.

@nijel nijel closed this as completed Feb 13, 2017
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 22, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Enhancement A feature request for improving phpMyAdmin
Projects
None yet
Development

No branches or pull requests

3 participants