Repo/process updates
jeffpaul opened this issue · 4 comments
jeffpaul commented
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.yml
workflow to one utilizing https://github.com/10up/action-wordpress-plugin-deploy <-- already prepared in #543 - The changelog in
readme.txt
links to https://github.com/wordpress/two-factor/releases. Should we have a full changeling inreadme.txt
? - Is
assets
folder within SVNtrunk
necessary given that duplicates the rootassets
folder? - License not fully correct per expected formats. composer.json properly lists
GPL-2.0-or-later
,package.json
showsGPL-2.0+
instead ofGPL-2.0-or-later
,two-factor.php
leaves out theLicense
andLicense URI
header fields, andreadme.txt
also leaves out theLicense
andLicense URI
header fields. I'd recommending ensuring all these noteGPL-2.0-or-later
as 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.php
andreadme.txt
match the formats/information as listed by the WP.org Plugin team inHeader Requirements
andPlugin Readmes
respectively. - Add a
develop
branch offmaster
and setdevelop
to the default branch such that all future PRs branch offdevelop
and releases happen by merging fromdevelop
intomaster
and tagging/releasing offmaster
. Similarly, renamemaster
totrunk
ormain
, update other references within the repo frommaster
to the new branch name including within GitHub Actions. - Create a
RELEASING.md
file to document the release process including text to copy/paste into an issue for release checklist, addRELEASING.md
to the.distignore
file. - 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
iandunn commented
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
compare
URL like 0.8.0...HEAD - Add a step to install the new version on a production site to make sure everything worked fine