JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 560
  • Score
    100M100P100Q96959F
  • License (MIT or CC0 1.0)

Deploy a branch to another branch with notifications.

Package Exports

  • deploy-vir
  • deploy-vir/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (deploy-vir) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

deploy-vir

Deploy from branch to branch via git.

Install

npm i -D deploy-vir

Setup

Add a TypeScript or JavaScript config file somewhere in your repo. Its default export should be your config:

import {defineDeployVirConfig, NotificationTarget} from 'deploy-vir';

export default defineDeployVirConfig({
    repos: [
        {
            /** This does not need to match the actual repo name. */
            name: 'whatever',
            gitUrl: 'git@github.com:electrovir/deploy-vir.git',
            deploys: [
                {
                    deployName: 'staging',
                    fromBranch: 'dev',
                    toBranch: 'staging',
                },
                {
                    deployName: 'prod',
                    fromBranch: 'staging',
                    toBranch: 'prod',
                },
            ],
        },
    ],
    notifications: [
        {
            target: NotificationTarget.Slack,
            webhookUrl: 'https://hooks.slack.com/services/X/X/X',
            channelName: '#deploys',
        },
    ],
});

Running

Then just run the CLI:

npx deploy-vir <path-to-config> <repo-name-to-deploy> <deploy-name-to-deploy>