two-factor
two-factor copied to clipboard
Repo/process updates
Is your enhancement related to a problem? Please describe.
In working through the 0.8.0 release, the following items came up that may be worth considering:
- Considering updating from the current
deploy.ymlworkflow to one utilizing https://github.com/10up/action-wordpress-plugin-deploy <-- already prepared in #543 - The changelog in
readme.txtlinks to https://github.com/wordpress/two-factor/releases. Should we have a full changeling inreadme.txt? - Is
assetsfolder within SVNtrunknecessary given that duplicates the rootassetsfolder? - License not fully correct per expected formats. composer.json properly lists
GPL-2.0-or-later,package.jsonshowsGPL-2.0+instead ofGPL-2.0-or-later,two-factor.phpleaves out theLicenseandLicense URIheader fields, andreadme.txtalso leaves out theLicenseandLicense URIheader fields. I'd recommending ensuring all these noteGPL-2.0-or-lateras the license and where links are required that we link to https://spdx.org/licenses/GPL-2.0-or-later.html - Similarly ensure that the other header fields in
two-factor.phpandreadme.txtmatch the formats/information as listed by the WP.org Plugin team inHeader RequirementsandPlugin Readmesrespectively. - Add a
developbranch offmasterand setdevelopto the default branch such that all future PRs branch offdevelopand releases happen by merging fromdevelopintomasterand tagging/releasing offmaster. Similarly, renamemastertotrunkormain, update other references within the repo frommasterto the new branch name including within GitHub Actions. - Create a
RELEASING.mdfile to document the release process including text to copy/paste into an issue for release checklist, addRELEASING.mdto the.distignorefile. - The plugin currently lists credits by linking to the GitHub Contributors view, but that does not take into account folks who help test/provide feedback on PRs, open well-defined issues, and other non-commit-related tasks. As such, while it may be a bit more effort during the release process I recommend adding a CREDITS.md file (example here) and adding a step to the release process for "Props: update CREDITS.md file with any new contributors, confirm maintainers are accurate."
Proposed Solution
No response
Designs
n/a
Describe alternatives you've considered
n/a
Please confirm that you have searched existing issues in this repository.
Yes
These things came up in the 0.8.1 release (#550):
- [ ] The person doing the release needs to be added to the plugin committer list on w.org, so that they get the release confirmation email, or someone who's already a committer needs to be available to confirm. It'd be good to link to where they can be added, and clarify that this is different from the contributor list.
- [ ] Mention that creating a release will automatically generate & attach zip/tarball files, because the release form asks for them to be uploaded
- [ ] Mention that someone needs to confirm the release. This is implied but not explicitly stated
- [ ] The changelog can be generated from a
compareURL like https://github.com/WordPress/two-factor/compare/0.8.0...HEAD - [ ] Add a step to install the new version on a production site to make sure everything worked fine