Merge pull request #230 from leapfrogtechnology/fix/update-docs

Update docs to reflect connection id filtering

Author: mesaugat

.github/workflows/build-publish.yml

@@ -93,6 +93,7 @@ jobs:
 
       - name: Run release script
         env:
+          GITHUB_TOKEN: ${{ secrets.RIBBY_GITHUB_TOKEN }}
           RIBBY_GITHUB_TOKEN: ${{ secrets.RIBBY_GITHUB_TOKEN }}
         run: ./release.sh compare_and_release
 

README.md

@@ -44,7 +44,7 @@ $ npm install -g @leapfrogtechnology/sync-db
 $ sync-db COMMAND
 running command...
 $ sync-db (-v|--version|version)
-@leapfrogtechnology/sync-db/2.1.0 linux-x64 node-v20.12.2
+@leapfrogtechnology/sync-db/2.1.0 darwin-arm64 node-v20.5.0
 $ sync-db --help [COMMAND]
 USAGE
   $ sync-db COMMAND

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@leapfrogtechnology/sync-db",
   "description": "Command line utility to synchronize and version control relational database objects across databases",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "license": "MIT",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/commands/migrate-latest.ts

@@ -13,8 +13,8 @@ class MigrateLatest extends Command {
   static flags = {
     'dry-run': flags.boolean({ description: 'Dry run migration.', default: false }),
     only: flags.string({
-      helpValue: 'CONNECTION_ID',
-      description: 'Filter only a single connection.'
+      helpValue: 'CONNECTION_ID(s)',
+      description: 'Filter provided connection(s). Comma separated ids eg: id1,id2'
     }),
     'connection-resolver': flags.string({
       helpValue: 'PATH',

src/commands/migrate-list.ts

@@ -11,8 +11,8 @@ class MigrateList extends Command {
 
   static flags = {
     only: flags.string({
-      helpValue: 'CONNECTION_ID',
-      description: 'Filter only a single connection.'
+      helpValue: 'CONNECTION_ID(s)',
+      description: 'Filter provided connection(s). Comma separated ids eg: id1,id2'
     }),
     'connection-resolver': flags.string({
       helpValue: 'PATH',

src/commands/migrate-rollback.ts

@@ -13,8 +13,8 @@ class MigrateRollback extends Command {
   static flags = {
     'dry-run': flags.boolean({ description: 'Dry run rollback.', default: false }),
     only: flags.string({
-      helpValue: 'CONNECTION_ID',
-      description: 'Filter only a single connection.'
+      helpValue: 'CONNECTION_ID(s)',
+      description: 'Filter provided connection(s). Comma separated ids eg: id1,id2'
     }),
     'connection-resolver': flags.string({
       helpValue: 'PATH',

src/commands/prune.ts

@@ -12,8 +12,8 @@ class Prune extends Command {
   static flags = {
     'dry-run': flags.boolean({ description: 'Dry run prune.', default: false }),
     only: flags.string({
-      helpValue: 'CONNECTION_ID',
-      description: 'Filter only a single connection.'
+      helpValue: 'CONNECTION_ID(s)',
+      description: 'Filter provided connection(s). Comma separated ids eg: id1,id2'
     }),
     'connection-resolver': flags.string({
       helpValue: 'PATH',

src/commands/synchronize.ts

@@ -19,8 +19,8 @@ class Synchronize extends Command {
     'dry-run': flags.boolean({ description: 'Dry run synchronization.', default: false }),
     'skip-migration': flags.boolean({ description: 'Skip running migrations.' }),
     only: flags.string({
-      helpValue: 'CONNECTION_ID',
-      description: 'Filter only a single connection.'
+      helpValue: 'CONNECTION_ID(s)',
+      description: 'Filter provided connection(s). Comma separated ids eg: id1,id2'
     }),
     'connection-resolver': flags.string({
       helpValue: 'PATH',