From 9377f03441d12f12a469d5653ba6d62920944281 Mon Sep 17 00:00:00 2001 From: april Date: Tue, 26 Apr 2022 14:15:45 +0100 Subject: [PATCH] Update Readme File Publishing release steps push release changes --- README.md | 6 +++++- lib/ably_ui/version.rb | 2 +- package.json | 2 +- preview/Gemfile | 2 +- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2d394664d..6de3d4438 100644 --- a/README.md +++ b/README.md @@ -384,16 +384,20 @@ This will trigger GitHub actions in supported apps (currently [Voltaire](http:// **To trigger a release:** -- Merge your PR into `main`. +- Make sure you have run pre-release script `./pre-release.sh` (This updates the gem and the npm package version for ably-ui in the following files `Gemfile`, `package.json`, `version.rb`). +- Merge your PR into `main` after it has been approved. - On the Github [Ably-UI](http://github.com/ably/ably-ui) repo, [create a new release](https://github.com/ably/ably-ui/releases/new) tag. - Create a new tag with the new version number for the release. - _Do not prefix the tag with a `v`_ - Add a meaningful title for the Release. - Click on the Autogenerate release notes button. - Publish Release. +- Check the Github `Actions` tab in the repo to make sure the release is green. This will release the packages, update library & preview app and create & push the commit & tag, and also create corresponding PRs in Voltaire & Website. +_Note: If the version number of the gem has been yanked you will need to increment the version number._ + ### Running tests The repo includes [Cypress](https://www.cypress.io/) for snapshot, screenshot, parity and behaviour testing. Cypress runs against the "preview" server (e.g. the same server used for development). diff --git a/lib/ably_ui/version.rb b/lib/ably_ui/version.rb index c1736fbca..0a5f7d28c 100644 --- a/lib/ably_ui/version.rb +++ b/lib/ably_ui/version.rb @@ -1,3 +1,3 @@ module AblyUi - VERSION = '7.3.2' + VERSION = '7.3.2.dev.66e4ce7' end diff --git a/package.json b/package.json index 31c03573d..334f731b2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ably/ui", - "version": "7.3.2", + "version": "7.3.2.dev.66e4ce7", "description": "Home of the Ably design system library ([design.ably.com](https://design.ably.com)). It provides a showcase, development/test environment and a publishing pipeline for different distributables.", "repository": { "type": "git", diff --git a/preview/Gemfile b/preview/Gemfile index 09475eb7e..996ef5d06 100644 --- a/preview/Gemfile +++ b/preview/Gemfile @@ -36,4 +36,4 @@ gem 'view_component', '~> 2.33.0', require: 'view_component/engine' gem 'responders' -gem 'ably-ui', '7.3.2', require: 'ably_ui' +gem 'ably-ui', '7.3.2.dev.66e4ce7', require: 'ably_ui'