@kekalma/dist-upload v1.0.9
dist-upload
Script for AWS S3 bucket upload from the distribution folder (linux version)
Latest release version: 1.1.2
Syntax: dist-upload optional params
| option | argument | description |
|---|---|---|
| -c | configFile | The name of the config file to save (-w) or use. aws.distconfig |
| -w | Config file write mode, for creating configuration(s). | |
| -p | profileName | Sets the AWS profile name. default |
| -r | regionName | Sets the AWS region name for the profile. us-east-1 |
| -a | accessKey | Sets the AWS IAM user's access_key for the profile. |
| -s | secretKey | Sets the AWS IAM user's secret_access_key for the profile. |
| -g | true | false | Should the name of the config file be added to .gitignore file. |
| -d | distDirectory | Sets the distribution directory. dist |
| -b | bucketName | Sets the AWS S3 bucket name in config. |
| -i | bucketName | off | Sets the AWS S3 bucket name for incremental release backup in config. |
| -R | Rollback (undo) release: Rolls back the code to previsous state, deleting the last release. | |
| -m | versionLimit | The maximum number of versions kept in the bucket. Older will be deleted. |
| -f | branchFolder | The folder for automated version storage. You can store different branches this way. |
| -l | tailNumber | Lists optionaly the last n number of the release versions in the incremental backup bucket. |
| -y | Answers default option to the config questions. Hint: use for changing only the given params. | |
| -S | Silent mode. Hides all the information about the process. |
Examples
To configure the system, as the first step:
dist-upload -wThe script will ask all the setup parameters and save it to the default config file. Creating a special config file (for example for staging):
dist-upload -c myTestConfig -wThis will create a config file 'myTestconfig', which can be used for alternative uploads. Sending this complete startup setup along with the webpack config to the team:
dist-upload -w -d dist -b ourProdBucket -i ourProdBackup -m 5
dist-upload -w -d build -b ourTestBucket -i off -c stageThe script will ask for the personal AWS access keys.
Hint: Place the above into the package.json under the 'scripts' like this: "init" : "dist-upload -w dist ..."
Updating the config file, changing ONLY the given params
(In this example switching off the backup and changing the region):
dist-upload -c myConfig -w -y -i off -r eu-west-1Uploading the folder 'test_build' (other than the folder set in config) in silent mode, while using the branch name 'stage':
dist-upload -d test_build -S -f stageListing the backup folder content, but only the last 3 versions:
dist-upload -l 3Uploading the dist folder (as set in the config) by leaving only 5 older versions alive, without status messages:
dist-upload -m 5 -SAny older versions above the number, will be deleted. Uploading to the previously configured staging area:
dist-upload -c stage
Written by: Attila Kiss, e-LET Kft, Hungary ( GitHub: kissato70 )
Licence: MIT