Skip to content

Commit

Permalink
Merge pull request #176 from ably/MAW-10
Browse files Browse the repository at this point in the history
Update Readme File Publishing release steps
  • Loading branch information
aralovelace authored Apr 26, 2022
2 parents 75dd190 + 9377f03 commit 45fb6e0
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion lib/ably_ui/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module AblyUi
VERSION = '7.3.2'
VERSION = '7.3.2.dev.66e4ce7'
end
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion preview/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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'

0 comments on commit 45fb6e0

Please sign in to comment.