From 82888de0364cac5b01420786e4ff2265a3070468 Mon Sep 17 00:00:00 2001 From: Tim Perry Date: Mon, 9 Oct 2017 19:10:50 +0200 Subject: [PATCH] Document how to `resin deploy` to an app as a collaborator Change-Type: patch --- build/actions/deploy.js | 2 +- doc/cli.markdown | 5 ++++- lib/actions/deploy.coffee | 5 ++++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/build/actions/deploy.js b/build/actions/deploy.js index 23cd45e4..92b3ec8e 100644 --- a/build/actions/deploy.js +++ b/build/actions/deploy.js @@ -152,7 +152,7 @@ uploadToPromise = function(uploadRequest, logger) { module.exports = { signature: 'deploy [image]', description: 'Deploy an image to a resin.io application', - help: 'Use this command to deploy an image to an application, optionally building it first.\n\nUsage: deploy ([image] | --build [--source build-dir])\n\nNote: If building with this command, all options supported by `resin build`\nare also supported with this command.\n\nExamples:\n $ resin deploy myApp --build --source myBuildDir/\n $ resin deploy myApp myApp/myImage', + help: 'Use this command to deploy an image to an application, optionally building it first.\n\nUsage: `deploy ([image] | --build [--source build-dir])`\n\nTo deploy to an app on which you\'re a collaborator, use\n`resin deploy /`.\n\nNote: If building with this command, all options supported by `resin build`\nare also supported with this command.\n\nExamples:\n $ resin deploy myApp --build --source myBuildDir/\n $ resin deploy myApp myApp/myImage', permission: 'user', options: dockerUtils.appendOptions([ { diff --git a/doc/cli.markdown b/doc/cli.markdown index c1ea7cb6..d1b39ec5 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -1414,7 +1414,10 @@ Squash newly built layers into a single new layer Use this command to deploy an image to an application, optionally building it first. -Usage: deploy ([image] | --build [--source build-dir]) +Usage: `deploy ([image] | --build [--source build-dir])` + +To deploy to an app on which you're a collaborator, use +`resin deploy /`. Note: If building with this command, all options supported by `resin build` are also supported with this command. diff --git a/lib/actions/deploy.coffee b/lib/actions/deploy.coffee index 1408ff6d..a0ddbb1a 100644 --- a/lib/actions/deploy.coffee +++ b/lib/actions/deploy.coffee @@ -114,7 +114,10 @@ module.exports = help: ''' Use this command to deploy an image to an application, optionally building it first. - Usage: deploy ([image] | --build [--source build-dir]) + Usage: `deploy ([image] | --build [--source build-dir])` + + To deploy to an app on which you're a collaborator, use + `resin deploy /`. Note: If building with this command, all options supported by `resin build` are also supported with this command.