[REQUEST] aws-elasticbeanstalk-deploy documentation updates

[Eric_Berens]

The documentation for the `aws-elasticbeanstalk-deploy` pipe could be improved as it doesn't match the values used in the actual code. I've created a patch to fix this since I don't have rights to contribute to the repo itself.

From 066e0f0597fb07bbd1da9c4778183c949341df7a Mon Sep 17 00:00:00 2001
From: Eric Berens <berens.eric@gmail.com>
Date: Tue, 19 Mar 2019 10:57:47 -0400
Subject: [PATCH] Update documentation

---
README.md | 5 ++---
pipe/pipe.sh | 4 ++--
2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 0c82405..8ac5a51 100644
--- a/README.md
+++ b/README.md
@@ -34,11 +34,10 @@ Add the following snippet to the script section of your `bitbucket-pipelines.yml
| APPLICATION_NAME (*) | The name of the Elastic Beanstalk application. |
| ENVIRONMENT_NAME (*) | Environment name. |
| ZIP_FILE (*) | The zip file to deploy. |
-| S3_BUCKET | Bucket name used by Elastic Beanstalk to store artifacts. Default: `${APPLICATION_NAME}-elasticbeanstalk-deployment}`. |
-| VERSION_LABEL | Version label for the new application revision. Default: `${ENVIRONMENT_NAME}_${BITBUCKET_COMMIT:0:8}_YYYY-mm-dd_HHMMSS)`. |
+| S3_BUCKET | Bucket name used by Elastic Beanstalk to store artifacts. Default: `${APPLICATION_NAME}-elasticbeanstalk-deployment`. |
+| VERSION_LABEL | Version label for the new application revision. Default: `${APPLICATION_NAME}-${BITBUCKET_BUILD_NUMBER}-${BITBUCKET_COMMIT:0:8}`. |
| WAIT | Wait for deployment to complete. Default: `false`. |
| WAIT_INTERVAL | Time to wait between polling for deployment to complete (in seconds). Default: `10`. |
-| DEBUG | Turn on extra debug information. |
| COMMAND | Command to be executed during the deployment. Valid options are `all`, `update-only`, `deploy-only`. Default: `all`. |
| DEBUG | Turn on extra debug information. Default: `false`. |
_(*) = required variable._
diff --git a/pipe/pipe.sh b/pipe/pipe.sh
index 90ecd9c..8ac0dec 100755
--- a/pipe/pipe.sh
+++ b/pipe/pipe.sh
@@ -11,8 +11,8 @@
#
# Optional globals:
#
-# S3_BUCKET (default: ${APPLICATION_NAME}-elasticbeanstalk-deployment})
-# VERSION_LABEL (default: ${APPLICATION_NAME}-${BITBUCKET_BUILD_NUMBER}-${BITBUCKET_COMMIT:0:8}
+# S3_BUCKET (default: ${APPLICATION_NAME}-elasticbeanstalk-deployment)
+# VERSION_LABEL (default: ${APPLICATION_NAME}-${BITBUCKET_BUILD_NUMBER}-${BITBUCKET_COMMIT:0:8})
# WAIT (default: false)
# WAIT_INTERVAL (default: 10)
# DEBUG (default: false)
--
2.17.1

[mwatson · Accepted solution]

Hi Eric, 

Thanks for the corrections!

Even if you don't have permissions to write to the repo, you should still be able to see the "edit" button when viewing files e.g. https://bitbucket.org/atlassian/aws-elasticbeanstalk-deploy/src/master/README.md

When you try to commit, Bitbucket will fork the repo for you and create a pull-request back to the original so that the maintainers can review it and suggest changes etc.

[Eric_Berens]

Done. I have submitted a PR (https://bitbucket.org/atlassian/aws-elasticbeanstalk-deploy/pull-requests/10).

Thanks.