Neatly Punctuated Musings
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    gulp-elasticbeanstalk-deploypublic

    gulp-elasticbeanstalk-deploy

    NPM Version Build Status Test Coverage

    Gulp plugin for deploying a set of files directly into an Amazon Elasticbeanstlak Instance

    Usage

    var gulp = require('gulp')
     ,  gulpEbDeploy = require('gulp-elasticbeanstalk-deploy')
     
    gulp.task('deploy', function() {
        return gulp.src([
            'config/**/*',
            'lib/**/*',
            'docs/**/*.html',
            'package.json'
        ], { base: './' })
        .pipe(gulpEbDeploy({
            name: 'my-application', // optional: If not set, the name from package.json will be used
            version: '1.0.0', // optional: If not set, the version from package.json will be used
            timestamp: true, // optional: If set to false, the zip will not have a timestamp
            waitForDeploy: true, // optional: if set to false the task will end as soon as it starts deploying
            amazon: {
                accessKeyId: "< your access key (fyi, the 'short' one) >", // optional
                secretAccessKey: "< your secret access key (fyi, the 'long' one) >", // optional
                signatureVersion: "v4", // optional
                region: 'eu-west-1',
                bucket: 'elasticbeanstalk-apps',
                applicationName: 'MyApplication',
                environmentName: 'my-application-env'
            }
        }))
    })

    The code above would work as follows

    • Take the files sepcified by gulp.src and zip them on a file named { version }-{ timestamp }.zip (i.e: 1.0.0-2016.04.08_13.26.32.zip)
    • If amazon credentials (accessKeyId, secretAccessKey) are provided in the amazon object, set them on the AWS.config.credentials. If not provided, the default values from AWS CLI configuration will be used.
    • Try to upload the zipped file to the bucket specified by amazon.bucket. If it fails because the bucket doesn't exist, try to create the bucket and then try to upload the zipped file again
    • Uploads the ziped files to the bucket on the path {{ name }}/{{ filename }} (i.e: my-application/1.0.0-2016.04.08_13.26.32.zip)
    • Creates a new version on the Application specified by applicationName with VersionLabel { version }-{ timestamp } (i.e: 1.0.0-2016.04.08_13.26.32)
    • Updates the Environment specified by environmentName by settings its application version to the new just uploaded
    • Waits for completion of the deploy process on the environment, informing on status changes

    install

    npm i gulp-elasticbeanstalk-deploy

    Downloadsweekly downloads

    291

    version

    1.1.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar