Skip to content
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.

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

New template for release PRs #2097

Merged
merged 2 commits into from
Apr 8, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release_pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Release for Gutenberg Mobile v1.XX.Y

## Related PRs

- Gutenberg: https://github.com/WordPress/gutenberg/pull/
- WPAndroid: https://github.com/wordpress-mobile/WordPress-Android/pull/
- WPiOS: https://github.com/wordpress-mobile/WordPress-iOS/pull/

- Aztec-iOS: https://github.com/wordpress-mobile/AztecEditor-iOS/pull/
- Aztec-Android: https://github.com/wordpress-mobile/AztecEditor-Android/pull

## Extra PRs that Landed After the Release Was Cut

- [ ] PR 1
- [ ] PR 2

## Changes
<!-- To determine the changes you can check the RELEASE-NOTES.txt file and cross check with the list of commits that are part of the PR -->

- Change 1
Copy link
Contributor

Choose a reason for hiding this comment

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

It might be worth adding some guidance here for how to determine the relevant changes in the form of a comment (so it doesn't actually show up in in the rendered content, i.e., <!-- To determine the changes from the last release you need to... -->). I like moving as many of those kinds of directions to here as is reasonable because then updates to the directions will go through PR review instead of just being changed by one person.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I found that for the changes you can just look at the commits show in the pull request itself instead of doing the terminal git command.

Copy link
Contributor

@mchowning mchowning Apr 1, 2020

Choose a reason for hiding this comment

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

Sure, that works too. I still think it might be nice to provide some guidance regarding what should be included as "Changes", but I don't feel strongly. Just having this template alone is a really great improvement. 😄

That does make me think though, is there any risk of us missing changes where

  1. change Add Flow to the project #1 is merged into gutenberg
  2. change Add Standard (style checking + auto formatting) to the project #2 is merged into gutenberg
  3. change Add Standard (style checking + auto formatting) to the project #2 is merged into gutenberg-mobile
  4. since ^that^ brought in change Add Flow to the project #1 already, there is no pr explicitly bringing change Add Flow to the project #1 into Gutenberg-mobile, so we miss it.

I think we're mostly ok because there should still be a release note for change #1 that would need to get merged, but we do forget if we forgot to update the release note we'd miss testing it too. This is more me just thinking out loud and not an issue with this PR.

- Change 2

## Test plan

- Use the main WP apps to test the changes above.
- Check WPAndroid and WPiOS PRs if there are specific tests to run.
- Smoke test the main WP apps for [general writing flow](https://github.com/wordpress-mobile/test-cases/tree/master/test-cases/gutenberg/writing-flow).

## Release Submission Checklist

- [ ] Release number was bumped
- [ ] Aztec dependencies are pointing to a stable release
- iOS: 'grep WordPressAztec-iOS RNTAztecView.podspec'
- Android: 'grep aztecVersion react-native-aztec/android/build.gradle'
- [ ] Gutenberg 'Podfile' and 'Podfile.lock' inside './ios/' are updated to the release number
- [ ] Bundle package of the release is updated
- [ ] Check if `RELEASE-NOTES.txt` is updated with all the changes that made it to the release