https://github.com/pr00xxy/shipper

extendable, pluggable, atomic deployment script written in python
https://github.com/pr00xxy/shipper

delivery deployment magento magento2 python3 revision website-deploy wordpress

Last synced: 4 months ago
JSON representation

extendable, pluggable, atomic deployment script written in python

• Host: GitHub
• URL: https://github.com/pr00xxy/shipper
• Owner: Pr00xxy
• License: mit
• Created: 2018-12-09T23:27:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-09-14T17:24:42.000Z (almost 5 years ago)
• Last Synced: 2025-01-13T03:42:06.916Z (5 months ago)
• Topics: delivery, deployment, magento, magento2, python3, revision, website-deploy, wordpress
• Language: Python
• Homepage:
• Size: 54.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Shipper

This project is based on the concept of atomic deployments with emphasising scalability and modularity.

Shipper does nothing except creating and maintaining the atomic deployment structure.

Any implementation or custom integrations are done by you with the use of plugins

Shipper was built to be run on Linux.

## Requirements

- python3

### Options

- `--revision` string of whatever you want the revision directory name to be

- `--deploy-dir` path to where Shipper should work. (default: where it's executed)

- `--deploy-cache-dir` location of you soon to be latest release (default: `cache` within `deploy-dir`)

- `--revisions-to-keep` number of old revisions to keep in addition to the current revision (default: `5`)

- `--symlinks`

    This can either be a JSON hash of symlinks or

    the filepath to a file containing json data

- `--help` prints help and usage instructions

- `--plugin-file` path to plugin file

- `--plugin-json` json hash that will be passed to the plugin

#### Plugins

Plugins are user made modules that can be hooked into the code at will.

To define a new plugin one must create a json file and pass it to shipper with

`--plugin`

Plugins are executed by dispatching events in the shipper code.

Looking inside the `Shipper.run()` we can find plugin dispatchers such as:

    self.dispatchEvent('before:initDirectories', pluginPath)

To add plugin to this event one must add the following structure to `plugin.json`:

    {

        "action": {

            "before:initDirectories": {

                "execute": [

                    "plugin.module_name.class_name.function_name"

                ]

            }

        }

    }

All events are objects in `action`

The `execute` directive tells Shipper what to execute and in what order.

In the example above Shipper will try to include `module_name` in the folder `plugin` and from that import `class_name` and then execute `function_name`

when instantiating the plugin class the `Shipper` class will be passed to the plugin class as the single argument, making Shipper available to the plugin class's functions.

Multiple instructions can be added to the `execute` array. They will be executed in ASC order

#### Symlinks

Symlinks are specified as `{"source":"link"}` and passed to the shipper script using the `--symlinks` parameter

- `source` is relative to the `--deploy-dir` path

- `link` is relative to the revision path

Symlinks can be specified as strings or as the path to json file containing the json hash.

**NOTE!** Files and directories that exist at the link location will be removed without notice.