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.

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

Add release documentation. #1294

Merged
merged 3 commits into from
Jun 9, 2020
Merged

Add release documentation. #1294

merged 3 commits into from
Jun 9, 2020

Conversation

SergioEstevao
Copy link
Contributor

Add a release document to the repo explaining the steps needed to create a new version.

To test:

  • Review the document to see if all is correct.

@SergioEstevao SergioEstevao mentioned this pull request Jun 8, 2020
Merged
2 tasks
mchowning
mchowning approved these changes Jun 9, 2020
View reviewed changes
Copy link
Contributor

@mchowning mchowning left a comment

Choose a reason for hiding this comment

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

Looks pretty good to me. Thanks @SergioEstevao ! 👍 I left a couple of minor comments, but I'll go ahead and approve.

Documentation/ReleaseProcess.md Outdated

### Step 2: Testing the Integration ###

Before going any further, It's normally good practice to test the Aztec integration into WordPress-iOS project, to make sure I won’t have to do the release process twice.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Lowercase "i" in "It's"
  • With the change from "I" to "it's" we now also need to update "make sure I won't...". Could be something like "make sure we won't...".

Documentation/ReleaseProcess.md Outdated

For simplicity Aztec uses a single milestone named “Next Stable”. The purpose of this milestone is to be used to assign to it all of the regular issues that are closed and merged into develop during the regular development process.

At this point in the release process you should rename the milestone to the version you’re about to release.
Copy link
Contributor

@mchowning mchowning Jun 9, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: "you're about to release" might be better as "you just released" since we've already merged to master and pushed the pod at this point.

mchowning added a commit to wordpress-mobile/gutenberg-mobile that referenced this pull request Jun 9, 2020
@mchowning
Update Aztec-iOS instructions to reference ReleaseProcess.md file
73796b4 
wordpress-mobile/AztecEditor-iOS#1294
@SergioEstevao SergioEstevao merged commit 185fef3 into develop Jun 9, 2020
@SergioEstevao SergioEstevao deleted the issue/add_release_documentation branch June 9, 2020 14:29
ceyhun added a commit to WordPress/gutenberg that referenced this pull request Jun 23, 2020
@Tug @mchowning
@lukewalczak @SergioEstevao @ceyhun @chipsnyder @dratwas @etoledom @marecar3 @guarani @enejb @cameronvoell @mkevins @hypest @gziolo
[Monorepo] Merge to master (#22714)
7532a48 
* Update gutenberg submodule ref

* Re-enable list spaces test

* Update gutenberg submodule ref

* Display radial gradient in block which supporting gradients (#2266)

* Update Aztec to version 1.19.2

* Commit hermes locally so we can build gutenberg using jitpack without installing all dependencies

* Remove hermes headers

* Update gutenberg ref before merge

* yarn version to 1.29.0

* Fix release note formatting

* Update to official version of Aztec

* Merge pull request #2322 from wordpress-mobile/issue/update_aztec_to_1.19.2

Update to official version of Aztec 1.19.2

* Update podfile.lock file.

* Fix link insertion at start of lists.

* Update github actions/cache to v2

* Only run gallery e2e tests

* Update version to 1.28.2

* Update bundles.

* Try different jest config

* Add 1.28.2 release note

* Try different jest config

* Add logs

* Update GB reference.

* Revert "Add logs"

This reverts commit 823d9bd.

* Add log

* Revert "Add log"

This reverts commit f684dc3.

* Add package-lock.json changes after npm install

* Force exit jest after all tests have completed running

* Update bundles

* Update podfile.lock

* Remove Keyboard.dismiss when deleting block (#2327)

* Update ref

* Update ref to point to master

* Update GB reference.

* Adjust how we're oulling theme elements from the bundle

* Update GB reference.

* Update bundles.

* Update list spaces test to not be canary test

* Update gutenberg submodule ref

* Update bundles

* Update bundle

* Fix: Button crash (#2332)

* Update GB reference.

* Update gb reference

* Update bundle files

* Update gutenberg ref

* Resolve Podfile.lock conflict

* Update .gitignore

* Update bridge build

* Update podfile.

* Fix link error in react-native-bridge/package.json

* Fix react-native entry in @wordpress/react-native-bridge package.json

* Update gutenberg ref

* Remove unused commands and update clean commands

* Add RNGetRandomValuesPackage to WPAndroid glue code

* Update working directory for npm related bridge commands

* Add contributing file.

* Decrease sleep time for android recording process

* Disable npm cache for android and ios runners

* Re-enable npm cache but use exact key for restore

* Use underscores with code of conduct file

* Update package-lock.json by re-adding react-native-editor to bust npm cache

* Remove nvm step from iOS runner

* Update bundle

* Decrease sleep time for android recording process

* Ignore and log android screen recording errors

* Update GB reference.

* Remove unused imports

* Update release notes and update gutenberg reference

* Recreate bundle

* Remove unnecessary patch files

* Try setting max worker to 2 to avoid error 137 on circle CI

* Update GB reference.

* update ref

* Update version to 1.29.1

* Update gutenberg submodule ref

* Update GB reference.

* Update bundles.

* Allow unsupported blocks to be edited on mobile (#2063)

Unsupported blocks can now be edited through a web view which utilizes the Gutenberg web editor. This is only available on development builds

Co-authored-by: Eduardo Toledo <eduardo.toledo@automattic.com>
Co-authored-by: Marko Savic <savicmarko1985@gmail.com>
Co-authored-by: Paul Von Schrottky <paul.von.schrottky@automattic.com>

* Update GB reference.

* Update GB reference.

* Update GB reference.

* Sort the release notes in the correct order.

* Update GB reference.

* Add release checklist

* Update GB reference.

* Update the VS code search settings to that seaching is easier

* Update version number

* Update Aztec-iOS instructions to reference ReleaseProcess.md file

wordpress-mobile/AztecEditor-iOS#1294

* Update bundles

* Added reference to release checklist template to template

* Remove info about bumping the version when not releasing

* Update release notes.

* Setup handshake mechanism for gutenberg bridge

* Simplify handshake

* Updated commands in README.md

* Adjust call for replaying events to call super to avoid the custom logic on the instance

* Revert unneeded changes and remove mocked event

* Update GB reference.

* Update bundles.

* Bump the version of the gutenberg that contains the fix

* Update to the latest version of the gutenberg submodule.

* Update gutenberg regerence

* Update bundle

* Update bridges methods to receive HTML content information metrics.

* Rename content info variables.

* Link wordcount package.

* Update to exclude the whole `bundle` folder

* Only exclude the App.js and App.js.map build files.

* Use Kotlin in react-native-gutenberg-bridge

* Use Xcode version 11.4.1 when running e2e tests

* Update package-lock.json

* Android implementation of the bridge.

* Add queue for deferred events

* Split and rename media upload message interfaces

* Implement a deferred event emitter

* Update release notes.

* Show all available information.

* Fix type gutenber => gutenberg

* Remove the gutenberg core build files since they should be ignored by default.

* Display block count information.

* Update GB reference.

* Adjust threading and method for queue

* Revert gutenberg change

* Trigger getting content and info

* Update RELEASE-NOTES

* Send non-critical messages safely from deferred event emitter

* Bump gutenberg version

* Bump gutenberg version

* Rerun bundle

* Refactor decoding step to an extension for ContentInfo

* Update format for content info.

* Move Gutenberg WebView related files to rn-gutenberg-bridge folder

* Update Android assets symlink to new assets folder

* Update GB reference.

* Adjust notification name to use existing extensions

* Update GB reference.

* Update GB reference.

* Update GB reference.

* Update bundles to support content structure on HTML request.

* Rename yarn_install to npm_install

* Radial gradient infrastructure (#2277)

* Fix react-native-bridge podspec

* Update to the latest gutenberg

* Simplify react-native-editor sass-transformer

* Fix react-native-bridge import

* Delete already deleted Media.java from react-native-bridge

* Fix lint erros

* Adjust optionality

* Fix duplicate kotlin_module error

* Rename interfaces in demo app

* Add release note

* Update package-lock.json

* The RN dep lives in the devDependencies section

* The gb-mobile root is now two more folders app

since the bridge code got two folders inside the gutenberg/packages
folder.

* Fix gutenberg-web-single-block symlink for unsupported blocks

* react-native-recyclerview is not used anymore

* Remove react-native-editor/bin folder

* Remove mentions of yarn, build is via npm now

* Use npm ci for reproducible builds

* [Fix] Columns block renders more than two columns in a row when launching in landscape mode (#2407)

* fix columnsInRow on init and some performance improvements

* update ref: rename getColumnWidth to contentStyle

* update ref to master

* Revert "Use npm ci for reproducible builds"

This reverts commit 6f7b9e5.

* Use latest node lts and npm versions

* Update react-native-bridge gradle script's path to root

Also added a check to insure that this kind of mistake gets caught
quickly in the future since otherwise it only reveals itself at runtime.

* Update bundleUpToDateCheck task to handle monorepo changes

* Check .scss files for changes

* Ignore changes to bundle directory and its subdirectories when doing up-to-date check

* Only check package.json for dependency changes

* Fix formatting

* Remove feature branch trigger from Travis CI

* Resolve merge issue in design doc

* Resolve merge issue in link-control/index.js

* Resolve merge issue in navigation-link/editor.scss

* Remove renamed angle-picker folder

* Update react-native-aztec README

* Remove react-native-aztec LICENSE file in favor of the repo's own license

* Update react-native-bridge README

* Delete GitHub issue and PR templates from react-native-editor

* Remove react-native-editor CONTRIBUTING file in favor of the repo's own one

* Remove react-native-editor LICENSE file in favor of the repo's own license

* Update react-native-editor README

* Remove top-level react-native script

* Update babel-jest to version 25.3.0

* Print message during execution instead of configuration

* Give more descriptive name to mobile gutenberg path variable

* Update packages/react-native-editor/README.md

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

* Update packages/react-native-editor/README.md

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

* Update .editorconfig to use spaces in files for Android

* Delete both node_modules folder when cleaning

* Extract file object construction out of loop

* Declare node modules folders at single location

* Add .npmrc files in react-native-* packages

Co-authored-by: Matt Chowning <matt.chowning@automattic.com>
Co-authored-by: Luke Walczak <lukasz.walczak.pwr@gmail.com>
Co-authored-by: Sergio Estevao <sergioestevao@gmail.com>
Co-authored-by: Ceyhun Ozugur <ceyhunozugur@gmail.com>
Co-authored-by: Chip Snyder <chip.snyder3@gmail.com>
Co-authored-by: Chip <chip.snyder@automattic.com>
Co-authored-by: Dratwas <drapich.piotr@gmail.com>
Co-authored-by: etoledom <etoledom@icloud.com>
Co-authored-by: Eduardo Toledo <eduardo.toledo@automattic.com>
Co-authored-by: Marko Savic <savicmarko1985@gmail.com>
Co-authored-by: Paul Von Schrottky <paul.von.schrottky@automattic.com>
Co-authored-by: Enej Bajgoric <enej.bajgoric@automattic.com>
Co-authored-by: Cameron Voell <cameronvoell@gmail.com>
Co-authored-by: Matthew Kevins <mmkevins@yahoo.com>
Co-authored-by: Stefanos Togkoulidis <stefanostogoulidis@gmail.com>
Co-authored-by: Matthew Kevins <mkevins@users.noreply.github.com>
Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>
maxme pushed a commit to wordpress-mobile/react-native-aztec that referenced this pull request Nov 17, 2020
@Tug @mchowning
@lukewalczak @SergioEstevao @ceyhun @chipsnyder @dratwas @etoledom @marecar3 @guarani @enejb @cameronvoell @mkevins @hypest @gziolo
[Monorepo] Merge to master (#22714)
7b16434 
* Update gutenberg submodule ref

* Re-enable list spaces test

* Update gutenberg submodule ref

* Display radial gradient in block which supporting gradients (#2266)

* Update Aztec to version 1.19.2

* Commit hermes locally so we can build gutenberg using jitpack without installing all dependencies

* Remove hermes headers

* Update gutenberg ref before merge

* yarn version to 1.29.0

* Fix release note formatting

* Update to official version of Aztec

* Merge pull request #2322 from wordpress-mobile/issue/update_aztec_to_1.19.2

Update to official version of Aztec 1.19.2

* Update podfile.lock file.

* Fix link insertion at start of lists.

* Update github actions/cache to v2

* Only run gallery e2e tests

* Update version to 1.28.2

* Update bundles.

* Try different jest config

* Add 1.28.2 release note

* Try different jest config

* Add logs

* Update GB reference.

* Revert "Add logs"

This reverts commit 823d9bd80bf81a839d8565c6004e1e61e4c1f6b2.

* Add log

* Revert "Add log"

This reverts commit f684dc3d18ed3dd3ea2d9abaccc46ca488ea3446.

* Add package-lock.json changes after npm install

* Force exit jest after all tests have completed running

* Update bundles

* Update podfile.lock

* Remove Keyboard.dismiss when deleting block (#2327)

* Update ref

* Update ref to point to master

* Update GB reference.

* Adjust how we're oulling theme elements from the bundle

* Update GB reference.

* Update bundles.

* Update list spaces test to not be canary test

* Update gutenberg submodule ref

* Update bundles

* Update bundle

* Fix: Button crash (#2332)

* Update GB reference.

* Update gb reference

* Update bundle files

* Update gutenberg ref

* Resolve Podfile.lock conflict

* Update .gitignore

* Update bridge build

* Update podfile.

* Fix link error in react-native-bridge/package.json

* Fix react-native entry in @wordpress/react-native-bridge package.json

* Update gutenberg ref

* Remove unused commands and update clean commands

* Add RNGetRandomValuesPackage to WPAndroid glue code

* Update working directory for npm related bridge commands

* Add contributing file.

* Decrease sleep time for android recording process

* Disable npm cache for android and ios runners

* Re-enable npm cache but use exact key for restore

* Use underscores with code of conduct file

* Update package-lock.json by re-adding react-native-editor to bust npm cache

* Remove nvm step from iOS runner

* Update bundle

* Decrease sleep time for android recording process

* Ignore and log android screen recording errors

* Update GB reference.

* Remove unused imports

* Update release notes and update gutenberg reference

* Recreate bundle

* Remove unnecessary patch files

* Try setting max worker to 2 to avoid error 137 on circle CI

* Update GB reference.

* update ref

* Update version to 1.29.1

* Update gutenberg submodule ref

* Update GB reference.

* Update bundles.

* Allow unsupported blocks to be edited on mobile (#2063)

Unsupported blocks can now be edited through a web view which utilizes the Gutenberg web editor. This is only available on development builds

Co-authored-by: Eduardo Toledo <eduardo.toledo@automattic.com>
Co-authored-by: Marko Savic <savicmarko1985@gmail.com>
Co-authored-by: Paul Von Schrottky <paul.von.schrottky@automattic.com>

* Update GB reference.

* Update GB reference.

* Update GB reference.

* Sort the release notes in the correct order.

* Update GB reference.

* Add release checklist

* Update GB reference.

* Update the VS code search settings to that seaching is easier

* Update version number

* Update Aztec-iOS instructions to reference ReleaseProcess.md file

wordpress-mobile/AztecEditor-iOS#1294

* Update bundles

* Added reference to release checklist template to template

* Remove info about bumping the version when not releasing

* Update release notes.

* Setup handshake mechanism for gutenberg bridge

* Simplify handshake

* Updated commands in README.md

* Adjust call for replaying events to call super to avoid the custom logic on the instance

* Revert unneeded changes and remove mocked event

* Update GB reference.

* Update bundles.

* Bump the version of the gutenberg that contains the fix

* Update to the latest version of the gutenberg submodule.

* Update gutenberg regerence

* Update bundle

* Update bridges methods to receive HTML content information metrics.

* Rename content info variables.

* Link wordcount package.

* Update to exclude the whole `bundle` folder

* Only exclude the App.js and App.js.map build files.

* Use Kotlin in react-native-gutenberg-bridge

* Use Xcode version 11.4.1 when running e2e tests

* Update package-lock.json

* Android implementation of the bridge.

* Add queue for deferred events

* Split and rename media upload message interfaces

* Implement a deferred event emitter

* Update release notes.

* Show all available information.

* Fix type gutenber => gutenberg

* Remove the gutenberg core build files since they should be ignored by default.

* Display block count information.

* Update GB reference.

* Adjust threading and method for queue

* Revert gutenberg change

* Trigger getting content and info

* Update RELEASE-NOTES

* Send non-critical messages safely from deferred event emitter

* Bump gutenberg version

* Bump gutenberg version

* Rerun bundle

* Refactor decoding step to an extension for ContentInfo

* Update format for content info.

* Move Gutenberg WebView related files to rn-gutenberg-bridge folder

* Update Android assets symlink to new assets folder

* Update GB reference.

* Adjust notification name to use existing extensions

* Update GB reference.

* Update GB reference.

* Update GB reference.

* Update bundles to support content structure on HTML request.

* Rename yarn_install to npm_install

* Radial gradient infrastructure (#2277)

* Fix react-native-bridge podspec

* Update to the latest gutenberg

* Simplify react-native-editor sass-transformer

* Fix react-native-bridge import

* Delete already deleted Media.java from react-native-bridge

* Fix lint erros

* Adjust optionality

* Fix duplicate kotlin_module error

* Rename interfaces in demo app

* Add release note

* Update package-lock.json

* The RN dep lives in the devDependencies section

* The gb-mobile root is now two more folders app

since the bridge code got two folders inside the gutenberg/packages
folder.

* Fix gutenberg-web-single-block symlink for unsupported blocks

* react-native-recyclerview is not used anymore

* Remove react-native-editor/bin folder

* Remove mentions of yarn, build is via npm now

* Use npm ci for reproducible builds

* [Fix] Columns block renders more than two columns in a row when launching in landscape mode (#2407)

* fix columnsInRow on init and some performance improvements

* update ref: rename getColumnWidth to contentStyle

* update ref to master

* Revert "Use npm ci for reproducible builds"

This reverts commit 6f7b9e5006993607cfb82515289033e3787dc050.

* Use latest node lts and npm versions

* Update react-native-bridge gradle script's path to root

Also added a check to insure that this kind of mistake gets caught
quickly in the future since otherwise it only reveals itself at runtime.

* Update bundleUpToDateCheck task to handle monorepo changes

* Check .scss files for changes

* Ignore changes to bundle directory and its subdirectories when doing up-to-date check

* Only check package.json for dependency changes

* Fix formatting

* Remove feature branch trigger from Travis CI

* Resolve merge issue in design doc

* Resolve merge issue in link-control/index.js

* Resolve merge issue in navigation-link/editor.scss

* Remove renamed angle-picker folder

* Update react-native-aztec README

* Remove react-native-aztec LICENSE file in favor of the repo's own license

* Update react-native-bridge README

* Delete GitHub issue and PR templates from react-native-editor

* Remove react-native-editor CONTRIBUTING file in favor of the repo's own one

* Remove react-native-editor LICENSE file in favor of the repo's own license

* Update react-native-editor README

* Remove top-level react-native script

* Update babel-jest to version 25.3.0

* Print message during execution instead of configuration

* Give more descriptive name to mobile gutenberg path variable

* Update packages/react-native-editor/README.md

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

* Update packages/react-native-editor/README.md

Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

* Update .editorconfig to use spaces in files for Android

* Delete both node_modules folder when cleaning

* Extract file object construction out of loop

* Declare node modules folders at single location

* Add .npmrc files in react-native-* packages

Co-authored-by: Matt Chowning <matt.chowning@automattic.com>
Co-authored-by: Luke Walczak <lukasz.walczak.pwr@gmail.com>
Co-authored-by: Sergio Estevao <sergioestevao@gmail.com>
Co-authored-by: Ceyhun Ozugur <ceyhunozugur@gmail.com>
Co-authored-by: Chip Snyder <chip.snyder3@gmail.com>
Co-authored-by: Chip <chip.snyder@automattic.com>
Co-authored-by: Dratwas <drapich.piotr@gmail.com>
Co-authored-by: etoledom <etoledom@icloud.com>
Co-authored-by: Eduardo Toledo <eduardo.toledo@automattic.com>
Co-authored-by: Marko Savic <savicmarko1985@gmail.com>
Co-authored-by: Paul Von Schrottky <paul.von.schrottky@automattic.com>
Co-authored-by: Enej Bajgoric <enej.bajgoric@automattic.com>
Co-authored-by: Cameron Voell <cameronvoell@gmail.com>
Co-authored-by: Matthew Kevins <mmkevins@yahoo.com>
Co-authored-by: Stefanos Togkoulidis <stefanostogoulidis@gmail.com>
Co-authored-by: Matthew Kevins <mkevins@users.noreply.github.com>
Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>
ceyhun pushed a commit to wordpress-mobile/release-toolkit-gutenberg-mobile that referenced this pull request Nov 20, 2020
@mchowning
Update Aztec-iOS instructions to reference ReleaseProcess.md file
fd10208 
wordpress-mobile/AztecEditor-iOS#1294
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mchowning mchowning mchowning approved these changes

Assignees
No one assigned
Labels
[Type] Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SergioEstevao @mchowning