Skip to content

Add release documentation #138

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.

Sign up for GitHub

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

Jump to bottom
Merged
JustinyAhin merged 13 commits into from
Feb 4, 2022
Merged

Add release documentation #138

JustinyAhin merged 13 commits into from
Feb 4, 2022

Conversation

@JustinyAhin
Copy link
Member

@JustinyAhin JustinyAhin commented Jan 31, 2022

Summary

This PR adds a new file Releasing-the-plugin.md with the release steps.

Fixes #131.

Checklist

  • PR has either [Focus] or Infrastructure label.
  • PR has a [Type] label.
  • PR has a milestone or the no milestone label.

@JustinyAhin JustinyAhin added [Type] Documentation Documentation to be added or enhanced Infrastructure Issues for the overall performance plugin infrastructure labels Jan 31, 2022
@JustinyAhin JustinyAhin added this to the 1.0.0-beta.1 milestone Jan 31, 2022
@JustinyAhin
Copy link
Member Author

JustinyAhin commented Jan 31, 2022 •
edited
Loading

@felixarntz @jeffpaul here is a draft for the release doc. There are still details to add, but I want us to agree on what's included before.

For now, here what the structure looks like:

  • Update version number
    • package.json
    • load.php
    • readme.txt
  • Update readme.txt
    • npm run readme -- -m "version"
  • Create a new GitHub release
  • ...

Any other things we should include/change?

felixarntz
felixarntz reviewed Jan 31, 2022
View reviewed changes
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JustinyAhin This is a good start, however I think there are a few things missing, and IMO it would be worth clarifying a couple things in more depth, particularly around the branches to use and also to keep other maintainers up to date on the process.

I've added a couple suggestions, let me know your thoughts.

JustinyAhin and others added 8 commits January 31, 2022 13:22
@JustinyAhin
Copy link
Member Author

JustinyAhin commented Jan 31, 2022

I've added a couple suggestions, let me know your thoughts.

@felixarntz thanks for looking. All your suggestions make sense. I've committed them to the PR and added a small change.

@JustinyAhin JustinyAhin marked this pull request as ready for review January 31, 2022 12:42
@eclarke1 eclarke1 requested a review from felixarntz February 3, 2022 14:04
@felixarntz felixarntz mentioned this pull request Feb 3, 2022
Closed
felixarntz
felixarntz approved these changes Feb 3, 2022
View reviewed changes
Copy link
Member

@felixarntz felixarntz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JustinyAhin Thank you, lgtm! I just added one more comment for your consideration, but it's not critical.

@JustinyAhin JustinyAhin merged commit 3195f38 into trunk Feb 4, 2022
@tillkruss tillkruss deleted the add/131-release-documentation branch March 7, 2022 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@felixarntz felixarntz felixarntz approved these changes

Assignees

No one assigned

Labels

Infrastructure Issues for the overall performance plugin infrastructure [Type] Documentation Documentation to be added or enhanced

Projects

None yet

Milestone

1.0.0-beta.1

Development

Successfully merging this pull request may close these issues.

Add release documentation

4 participants

@JustinyAhin @felixarntz @eclarke1