Add changelog & credits, update release notes #696
Conversation
| - Add developer tools for deploying to WP.org manually. | ||
|
|
||
| [Unreleased]: https://github.com/WordPress/two-factor/compare/master...develop | ||
| [0.13.0]: https://github.com/WordPress/two-factor/compare/0.12.0...0.13.0 |
There was a problem hiding this comment.
Oh, wow. I didn't know markdown supported footer links like that. I wonder if this should be included in the release instructions because people might not realize that those headings are expecting a link.
Alternatively, could we inline the link with the heading? It is more verbose but makes it clear that the expectation is to include the link there.
There was a problem hiding this comment.
You tell me, do you want it in the footer or each release header? Happy to adjust in either direction and add to the RELEASING.md accordingly.
There was a problem hiding this comment.
I'd prefer to have it inline with each version heading. That makes it an obvious requirement.
CREDITS.md
Outdated
|
|
||
| Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc. | ||
|
|
||
| [853 (@Sonic853)](https://github.com/Sonic853), [Aaron Campbell (@aaroncampbell)](https://github.com/aaroncampbell), [Alexandru Apostol (@aapost0l)](https://github.com/aapost0l), [Ali Husnain (@alihusnainarshad)](https://github.com/alihusnainarshad), [Anton Vanyukov (@av3nger)](https://github.com/av3nger), [Arslan Kalwar (@akkspros)](https://github.com/akkspros), [Axel Simon (@axelsimon)](https://github.com/axelsimon), [Birgit Pauli-Haack (@bph)](https://github.com/bph), [Brooke. (@BrookeDot)](https://github.com/BrookeDot), [Calvin Alkan (@calvinalkan)](https://github.com/calvinalkan), [Carlos Faria (@cfaria)](https://github.com/cfaria), [Christian Chung (@christianc1)](https://github.com/christianc1), [Clayton Collie (@claytoncollie)](https://github.com/claytoncollie), [Connor Jennings (@cojennin)](https://github.com/cojennin), [Derek Herman (@valendesigns)](https://github.com/valendesigns), [Dion Hulse (@dd32)](https://github.com/dd32), [fossyatra (@netweb)](https://github.com/netweb), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [John Blackbourn (@johnbillion)](https://github.com/johnbillion), [John James Jacoby (@JJJ)](https://github.com/JJJ), [Josh Betz (@joshbetz)](https://github.com/joshbetz), [Kurt Zenisek (@KZeni)](https://github.com/KZeni), [Ian Dunn (@iandunn)](https://github.com/iandunn), [Mario Hoyos (@squaredpx)](https://github.com/squaredpx), [Mathesh (@Mati02K)](https://github.com/Mati02K), [Mehul Gohil (@mehul0810)](https://github.com/mehul0810), [Nauris Pūķis (@pyronaur)](https://github.com/pyronaur), [Neil Batchelor (@nbwpuk)](https://github.com/nbwpuk), [Ole Melhus (@omelhus)](https://github.com/omelhus), [Pascal Birchler (@swissspidy)](https://github.com/swissspidy), [Paul Kevan (@pkevan)](https://github.com/pkevan), [Paul Schreiber (@paulschreiber)](https://github.com/paulschreiber), [r-a-y (@r-a-y)](https://github.com/r-a-y), [Sergey Jinks (@sjinks)](https://github.com/sjinks), [sgrant (@sgrant)](https://github.com/sgrant), [Shai Sapphire (@shay1383)](https://github.com/shay1383), [Spenser Hale (@spenserhale)](https://github.com/spenserhale), [Stefan Momm (@stefanmomm)](https://github.com/stefanmomm), [Steve Grunwell (@stevegrunwell)](https://github.com/stevegrunwell), [Steven Word (@stevenkword)](https://github.com/stevenkword), [Thrijith Thankachan (@thrijith)](https://github.com/thrijith), [Tomasz Dziuda (@dziudek)](https://github.com/dziudek), [Toni Viemerö (@todeveni)](https://github.com/todeveni), [Viktor Szépe (@szepeviktor)](https://github.com/szepeviktor). |
There was a problem hiding this comment.
Did you generate this list somehow? Should we include it in the release instructions? Are we including every contributor here?
There was a problem hiding this comment.
I did a quick scan of folks that were called out, noting there are a couple I just found that I need to add. Definitely needs to be added to RELEASING.md so that's not left off.
Are you ok with the alpha order here? Do you want me to split into sub-sections (e.g. ### A-G, ### H-M, etc)?
There was a problem hiding this comment.
No preference. Whatever you suggest.
| @@ -56,4 +56,28 @@ To report a security issue, please visit the [WordPress HackerOne](https://hacke | |||
|
|
|||
| == Changelog == | |||
|
|
|||
| See the [release history](https://github.com/wordpress/two-factor/releases). | |||
| = 0.13.0 - 2025-04-02 = | |||
There was a problem hiding this comment.
What's the expectation around this changelog and the CHANGELOG.md? Do we keep them in sync manually?
There was a problem hiding this comment.
My thinking was we keep the last X releases in the readme so there's some content there but maintain the full listing on GH in the CHANGELOG.md file. I can update RELEASING.md to note that distinction.
There was a problem hiding this comment.
Sounds good. We can probably implement some release magic that extracts the top items from the CHANGELOG file and places them here. That way we only need to update in a single location.
| - Update automated testing to cover PHP 8.4 and default to PHP 8.3 by @BrookeDot in #665 | ||
|
|
||
| = 0.12.0 - 2025-02-14 = | ||
| - Simplify the Two Factor settings in user profile by @kasparsd in #654 |
There was a problem hiding this comment.
On GitHub the author and pull request number would get linked automatically. I wonder if we should do that here too. Having that data without the links really doesn't help users to quickly see what is included.
There was a problem hiding this comment.
Yeah, we do that over on 10up projects, happy to do so here as well. Will update accordingly.
|
Note that along with @kasparsd review comments above that I'll update the PR with the latest release as well https://github.com/WordPress/two-factor/releases/tag/0.14.0 |
What?
This pull request introduces documentation updates to improve clarity and accessibility for contributors and users. Key changes include the addition of a comprehensive changelog, a dedicated credits file, and enhancements to release and security documentation.
Documentation Updates:
Changelog:
CHANGELOG.mdfile to document all notable changes in the project, adhering to the Keep a Changelog standard and Semantic Versioning. This provides a detailed history of updates, fixes, and features across versions.readme.txtto include a summary of recent changes and a link to the full changelog for complete details.Credits:
CREDITS.mdfile listing maintainers, contributors, and libraries utilized in the project. This acknowledges the efforts of all individuals involved and improves transparency.readme.mdto link to the newCREDITS.mdfile for contributor recognition.Release Process:
RELEASING.mdwith additional instructions for plugin committers, ensuring smoother release management and clarifying the committer requirements on wp.org.Why?
Resolves the remaining, outstanding items in #544.
How?
Testing Instructions
Screenshots or screencast
Changelog Entry