Merge branch 'master' of github.com:lucaperret/drone-now

Author: lucaperret

.drone.yml

@@ -3,6 +3,7 @@ pipeline:
     image: plugins/docker
     secrets: [ docker_username, docker_password ]
     repo: lucap/drone-now
-    auto_tag: true
     when:
       event: tag
+branches:
+  - master

DOCS.md

@@ -8,87 +8,148 @@ logo: now.svg
 image: lucap/drone-now
 ---
 
-The Now plugin deploy your build to [now.sh](https://zeit.co/now). The below pipeline configuration demonstrates simple usage:
+The Now plugin deploy your build to [now.sh](https://zeit.co/now).
+
+The below pipeline configuration demonstrates simple usage:
+
+Note: `deploy_name` is an optional parameter. If it is not given now.sh will use name of the working directory .
 
 ```yaml
 pipeline:
   now:
     image: lucap/drone-now
-    token: xxxxx
-    name: deployment-name
+    deploy_name: deployment-name
+    now_token: keep-this-secret
 ```
 
-Example configuration for assigning [Aliases and Domains](https://zeit.co/docs/features/aliases):
+Or use the secret NOW_TOKEN instead, if you supply both the plugin will use the `now_token` parameter first
 
 ```diff
 pipeline:
   now:
     image: lucap/drone-now
-    token: xxxxx
--   name: deployment-name
-+   alias: my-deployment-alias
+    deploy_name: deployment-name
+-   now_token: keep-this-secret
++   secrets: [ now_token ]
 ```
 
-Example configuration with custom [Path Aliases](https://zeit.co/docs/features/path-aliases):
+Set the directory you want to deploy. See the [Deployment Documentation](https://zeit.co/docs/getting-started/deployment#) for more info.
 
 ```diff
 pipeline:
   now:
     image: lucap/drone-now
-    token: xxxxx
--   alias: my-deployment-alias
-+   rules_domain: example.com
-+   rules_file: rules.json
+    deploy_name: deployment-name
+    secrets: [ now_token ]
++   directory: public
 ```
 
-Example configuration for [Scaling](https://zeit.co/docs/getting-started/scaling):
+Example configuration with team scope:
 
 ```diff
 pipeline:
   now:
     image: lucap/drone-now
-    token: xxxxx
--   rules_domain: example.com
--   rules_file: rules.json
-+   scale: 2
+    deploy_name: deployment-name
+    secrets: [ now_token ]
+-   directory: public
++   team: myteam
 ```
 
+
 Example configuration to enforce type (by default, it's detected automatically):
 
 ```diff
 pipeline:
   now:
     image: lucap/drone-now
-    token: xxxxx
--   scale: 2
+    deploy_name: deployment-name
+    secrets: [ now_token ]
+-   team: myteam
 +   type: npm
 ```
 
-Example configuration using token from secrets:
+Example configuration for assigning [Aliases and Domains](https://zeit.co/docs/features/aliases):
 
 ```diff
 pipeline:
   now:
     image: lucap/drone-now
--   token: xxxxx
-+   secrets: [ now_token ]
+    deploy_name: deployment-name
+    secrets: [ now_token ]
+-   type: npm
++   alias: my-deployment-alias
+```
+
+Example configuration for [Cleaning Up Old Deployments](https://zeit.co/docs/other/faq#how-do-i-remove-an-old-deployment):
+
+Note: You must set the `alias` parameter with `cleanup`.
+
+```diff
+pipeline:
+  now:
+    image: lucap/drone-now
+    deploy_name: deployment-name
+    secrets: [ now_token ]
++   alias: my-deployment-alias
++   cleanup: true
+```
+
+Example configuration with custom [Path Aliases](https://zeit.co/docs/features/path-aliases):
+
+```diff
+pipeline:
+  now:
+    image: lucap/drone-now
+    deploy_name: deployment-name
+    secrets: [ now_token ]
+-   alias: my-deployment-alias
+-   cleanup: true
++   rules_domain: example.com
++   rules_file: rules.json
 ```
 
+Example configuration for [Scaling](https://zeit.co/docs/getting-started/scaling):
+
+```diff
+pipeline:
+  now:
+    image: lucap/drone-now
+    deploy_name: deployment-name
+    secrets: [ now_token ]
+-   rules_domain: example.com
+-   rules_file: rules.json
++   scale: 2
+```
+
+
 # Secret Reference
 
 now_token
 : Now token
 
 # Parameter Reference
 
-token
-: Now token
+now_token
+: Your API token (can also be set implicitly with a secret named NOW_TOKEN)
 
-name
+deploy_name
 : Set the name of the deployment
 
+directory
+: The directory you want to deploy
+
+team
+: Set the team scope
+
+type
+: Deployment type (docker, npm, static)
+
 alias
-: Target Now.sh subdomain or domain
+: Target now.sh subdomain or domain
+
+cleanup
+: Equivalent to `now rm --safe --yes $alias`
 
 rules_domain
 : Your domain
@@ -97,7 +158,4 @@ rules_file
 : File that contain set of rules
 
 scale
-: Min and Max scaling values
-
-type
-: Deployment type (docker, npm, static)
+: Min and Max scaling values

README.md

@@ -25,7 +25,8 @@ Deploy the working directory to now.
 
 ```bash
 docker run --rm \
-  -e PLUGIN_TOKEN=xxxxx \
+  -e NOW_TOKEN=xxxxxxx \
+  -e PLUGIN_DEPLOY_NAME=my-deployment-name \
   -e PLUGIN_ALIAS=my-deployment-alias.now.sh \
   -v $(pwd):$(pwd) \
   -w $(pwd) \
@@ -38,6 +39,10 @@ docker run --rm \
 pipeline:
   now:
     image: lucap/drone-now
-    token: xxxxx
-    alias: my-deployment-alias.now.sh
+    deploy_name: my-deployment-name
+    type: static
+    team: xxxxxxxx
+    directory: public
+    alias: my.deployment.com
+    secrets: [ now_token ]
 ```

script.sh

@@ -1,49 +1,97 @@
 #!/bin/sh
 set -e
 
-NOW_TOKEN_OPTION="--token=$PLUGIN_TOKEN"
-NOW_DEPLOY_OPTIONS="${NOW_TOKEN_OPTION} --no-clipboard"
+NOW_DEPLOY_OPTIONS=" --no-clipboard"
+NOW_AUTH=""
 
-if [ -n "$PLUGIN_NAME" ]
+# Get the token or error
+if [ -z "$PLUGIN_NOW_TOKEN" ]
 then
-    NOW_DEPLOY_OPTIONS="${NOW_DEPLOY_OPTIONS} --name ${PLUGIN_NAME}"
+    # No explicit token provided, check for secret
+    if [ -z "$NOW_TOKEN" ]
+    then
+        echo "> Error!! either the parameter now_token or the secret NOW_TOKEN is required!"
+        exit 1;
+    else
+        PLUGIN_NOW_TOKEN="$NOW_TOKEN"
+    fi
 fi
 
-if [ -n "$PLUGIN_TYPE" ]
+if [ -n "$PLUGIN_TEAM" ]
+then
+    echo "> adding custom team scope $PLUGIN_TEAM"
+    NOW_TEAM_OPTION="--team $PLUGIN_TEAM"
+else
+    echo "> No custom team scope provided."
+fi
+
+NOW_AUTH="$NOW_AUTH --token $PLUGIN_NOW_TOKEN $NOW_TEAM_OPTION"
+
+if [ -n "$PLUGIN_DEPLOY_NAME" ]
 then
-    NOW_DEPLOY_OPTIONS="${NOW_DEPLOY_OPTIONS} --${PLUGIN_TYPE}"
+    echo "> adding deploy_name $PLUGIN_DEPLOY_NAME"
+    NOW_DEPLOY_OPTIONS="${NOW_DEPLOY_OPTIONS} --name $PLUGIN_DEPLOY_NAME"
+else
+    echo "> No deployment name provided. The directory will be used as the name"
 fi
 
-if [ -n "$PLUGIN_TOKEN" ]
+if [ -n "$PLUGIN_TYPE" ]
 then
-    echo "> Deploying on now.sh…" &&
-    NOW_DEPLOYMENT_URL=$(now $NOW_DEPLOY_OPTIONS) &&
-    echo "> Success! Deployment complete to $NOW_DEPLOYMENT_URL!";
+    echo "> adding type $PLUGIN_TYPE"
+    NOW_DEPLOY_OPTIONS="${NOW_DEPLOY_OPTIONS} --$PLUGIN_TYPE"
 else
-    echo "> Error! NOW_TOKEN is required"
+    echo "> No deployment type provided, now.sh will try to detect it..."
 fi
 
+if [ -n "$PLUGIN_DIRECTORY" ]
+then
+    echo "> Deploying $PLUGIN_DIRECTORY on now.sh…"
+fi
+
+NOW_DEPLOYMENT_URL=$(now $NOW_AUTH $NOW_DEPLOY_OPTIONS $PLUGIN_DIRECTORY) &&
+echo "> Success! Deployment complete to $NOW_DEPLOYMENT_URL";
+
 if [ -n "$PLUGIN_ALIAS" ]
 then
     echo "> Assigning alias…" &&
-    ALIAS_SUCCESS_MESSAGE=$(now alias $NOW_DEPLOYMENT_URL $PLUGIN_ALIAS $NOW_TOKEN_OPTION) &&
+    ALIAS_SUCCESS_MESSAGE=$(now alias $NOW_AUTH $NOW_DEPLOYMENT_URL $PLUGIN_ALIAS) &&
     echo "$ALIAS_SUCCESS_MESSAGE" &&
     NOW_DEPLOYMENT_URL="https://$PLUGIN_ALIAS";
 fi
 
+if [ "$PLUGIN_CLEANUP" == "true" ]
+then
+    if [ -n "$PLUGIN_ALIAS" ]
+    then
+        echo "> Cleaning up old deployments…" &&
+        ALIAS_SUCCESS_MESSAGE=$(now rm --safe --yes $NOW_AUTH $PLUGIN_ALIAS) &&
+        echo "$ALIAS_SUCCESS_MESSAGE"
+    else
+        echo "> Warning!! You must set the alias parameter when using the cleanup parameter so that now.sh knows which deployments to remove!"
+    fi
+fi
+
 if [ -n "$PLUGIN_SCALE" ]
 then
     echo "> Scaling…" &&
-    SCALE_SUCCESS_MESSAGE=$(now scale $NOW_DEPLOYMENT_URL $PLUGIN_SCALE $NOW_TOKEN_OPTION) &&
+    SCALE_SUCCESS_MESSAGE=$(now scale $NOW_AUTH $NOW_DEPLOYMENT_URL $PLUGIN_SCALE) &&
     echo "$SCALE_SUCCESS_MESSAGE";
 fi
 
 if [ -n "$PLUGIN_RULES_DOMAIN" ] && [ -n "$PLUGIN_RULES_FILE" ]
 then
     echo "> Assigning domain rules…" &&
-    RULES_SUCCESS_MESSAGE=$(now alias $PLUGIN_RULES_DOMAIN -r $PLUGIN_RULES_FILE $NOW_TOKEN_OPTION) &&
+    RULES_SUCCESS_MESSAGE=$(now alias $NOW_AUTH $PLUGIN_RULES_DOMAIN -r $PLUGIN_RULES_FILE) &&
     echo "$RULES_SUCCESS_MESSAGE" &&
     NOW_DEPLOYMENT_URL=$PLUGIN_ALIAS;
 fi
 
-echo $'\n'"> Successfully deployed! $NOW_DEPLOYMENT_URL"$'\n'
+## Check exit code
+rc=$?; 
+if [[ $rc != 0 ]];
+then 
+    echo "> non-zero exit code $rc" &&
+    exit $rc
+else
+    echo $'\n'"> Successfully deployed! $NOW_DEPLOYMENT_URL"$'\n'
+fi