Release-it for Uploadcare

This is a set of scripts used to release our open-source projects. It is based on release-it and gh-pages libraries.

Requirements

Expected project structure:

.
├── .release-it.json
├── demo (needed for deploy-demo)
│   └── index.html
├── dist
    ├── uploadcare-plugin.js
├── index.html (needed for deploy-demo)

Install

npm install @uploadcare/release-it --save-dev

Configuration

Create file named .release-it.json inside your project:

touch .release-it.json

Possible options:

{
  "archiveName": "uploadcare-plugin",
  "buildCommand": "npm run build",
  "githubRelease": true,
  "createArchives": true,
  "npmPublish": true,
  "deployRelease": true,
  "deployDemo": true,
  "dryRun": false,
  "demoSrc": ["index.html", "demo/**", "dist/**"],
  "releaseSrc": "./dist/",
}

Property archiveName is the name for tar and zip archives attached to the GitHub release. By default it is package name from package.json.

These options is passed down to the release-it so you can set some specific options for it.

Usage

To start deploy

./node_modules/.bin/release-it

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

1.1.0, 2018-10-31

Added

• Option to change demo and release source path

1.0.1, 2018-06-13

Added

• Call release-it with predefined options
• Create dist tar and zip archives before deploy to GitHub releases
• Deploy dist to release branch
• Deploy demo to gh-pages branch