README.md in synchronised_migration-2.1.2 vs README.md in synchronised_migration-2.2.0
- old
+ new
@@ -1,8 +1,9 @@
# Synchronised Migration
-[![Build Status](https://travis-ci.org/sealink/synchronised-migration-rb.svg?branch=master)](https://travis-ci.org/sealink/synchronised-migration-rb)
+[![Gem Version](https://badge.fury.io/rb/synchronised_migration.svg)](http://badge.fury.io/rb/synchronised_migration)
+[![Build Status](https://github.com/sealink/synchronised-migration-rb/workflows/Build%20and%20Test/badge.svg?branch=master)](https://github.com/sealink/synchronised-migration-rb/actions)
This gem makes it possible to deploy multiple instances with data migration
simultaneously. It uses Redis to ensure that there will be only one migration
running.
@@ -15,11 +16,11 @@
## Usage
Module `SynchronisedMigration` needs to be configured as below.
-```
+```ruby
SynchronisedMigration.configure do |config|
config.host = 'example.com'
config.port = 6379
config.db = 0
end
@@ -43,8 +44,16 @@
```
$ rake synchronised_migrate:execute
```
-## Testing
+## Release
-Please refer to `.travis.yml` for testing.
+To publish a new version of this gem the following steps must be taken.
+
+* Update the version in the following files
+ ```
+ CHANGELOG.md
+ lib/synchronised_migration/version.rb
+ ````
+* Create a tag using the format v0.1.0
+* Follow build progress in GitHub actions