Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Add full changelog display to admin dashboard #422
The ClassicPress admin dashboard should show the same changelogs as our official release posts in the forums: https://forums.classicpress.net/c/announcements/release-notes
Right now these changelogs appear in 2 different places (on the forums and on GitHub). To avoid having 3 places, it might be nice to come up with a way to automatically pull the content from a single source (most likely GitHub).
Or, we could take the simplest route and just add a link from the admin dashboard to the releases subforum.
Yes and Yes, This should be workeable. I have used a sample repo on my github space and tapped into the Github release api - https://api.github.com/repos/bahiirwa/years-since-repo/releases/latest
Inset are the results.
It is possible to actually pull this in and only go for the body to get the release notes.
I didn't think of pulling this data from the GitHub API. Let's do it, I think that will work really nicely. The release entries for 1.0.0 and 1.0.1 already have all the data and links we'll want to include there, and we can keep this going for future versions:
Two issues that come to mind right now:
I think the solution to both of these problems is to add a "proxy" API endpoint to api-v1.classicpress.net, as we've done for the petitions widget. (While we're at it, we should probably add some caching to that endpoint too.)
Requests would not be frequent, we could store the result in a very long transient (1 month for example).
2 reasons for this:
referenced this issue
Jul 15, 2019
Postponing this issue until later, since there is still a lot to do in order to make it work.
Let's go with this for v1.1.0 → #449
Another difficulty to consider with the full changelog approach described here is translations. We would probably be providing the changelogs in English only, which is not ideal.