Nincompoops Producing Methane
    Wondering what’s next for npm?Check out our public roadmap! »

    gulp-stamplay

    1.0.0 • Public • Published

    gulp-stamplay

    Deploy your project with a gulp plugin

    Getting Started

    If you haven't used Gulp before, be sure to check out the Getting Started guide, as it explains how to create a Gulpfile as well as install and use Gulp plugins. Once you're familiar with that process, you may install this plugin with this command:

    npm install gulp-stamplay --save-dev

    Once the plugin has been installed, it may be enabled inside your Gulpfile with this line of JavaScript:

    var options = {
      appId: 'YOUR-APPID',
      apiKey: 'YOUR-APIKEY',
      public: './src'
    }
     
    var stamplay = require('gulp-stamplay')(options);

    Usage

    gulp.task('task-name', function () {
      return gulp.src('src/*')
        .pipe(stamplay.deploy({
          message: 'deploy message',
          ignore: [
            'src/index_dev.html'
          ]
        })
      )
    });

    Options

    options.appId

    Type: String

    The appId of the project on Stamplay

    options.apiKey

    Type: String

    The apiKey of the project on Stamplay

    options.public

    Type: String

    The public property tells the task which directory to upload to Stamplay. This directory must be inside the project directory and must exist. The default value is the root directory or your project.

    API

    deploy(deployOptions)

    In this example, headers property is used to specify to the Stamplay platform that all files with .html extension can be cached from the client. You can find more informations about options here

    deployOptions.message

    Type: String

    The message to describe the deploy

    deployOptions.ignore

    Type: Array

    Files that will not be uploaded during the deploy

    deployOptions.headers

    Type: Array

    Specifies headers for client caching

    gulp.task('task-name', function () {
      return gulp.src('src/*')
        .pipe(stamplay.deploy({
          message: 'deploy message',
          ignore: [
            'src/index_dev.html'
          ],
          headers: [{
            source: '**/*.@(html)',
            headers: [{
              key: 'Cache-Control',
              value: 'max-age=7200'
            }]
          }]
        })
      )
    });

    Release History

    v1.0.0 - (22-03-2016)

    - Stamplay deploy task
    

    Install

    npm i gulp-stamplay

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • avatar