https://github.com/terminus-plugin-project/terminus-hotfix-plugin
A Terminus Plugin that adds command(s) to facilitate a hotfix workflow for Pantheon sites.
https://github.com/terminus-plugin-project/terminus-hotfix-plugin
Last synced: about 1 year ago
JSON representation
A Terminus Plugin that adds command(s) to facilitate a hotfix workflow for Pantheon sites.
- Host: GitHub
- URL: https://github.com/terminus-plugin-project/terminus-hotfix-plugin
- Owner: terminus-plugin-project
- License: mit
- Created: 2018-06-04T21:40:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-07-10T18:35:39.000Z (almost 7 years ago)
- Last Synced: 2025-02-14T23:16:40.913Z (over 1 year ago)
- Language: PHP
- Size: 877 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terminus Hotfix Plugin
A [Terminus](http://github.com/pantheon-systems/terminus) plugin that adds the commands to facilitate hotfix workflows on [Pantheon](https://pantheon.io/) sites.
## Demo Video
[](https://youtu.be/T9ukNUGLXnE "Terminus Hotfix Plugin Demo Video")
## Disclaimer
While this plugin has worked well for us your mileage may vary due to local machine configuration. This repository is provided without warranty or direct support. Issues and questions may be filed in GitHub but their resolution is not guaranteed.
## Installation
Clone this project into your Terminus plugins directory found at `$HOME/.terminus/plugins`. If the `$HOME/.terminus/plugins` directory does not exists you can safely create it. You will also need to run `composer install` in the plugin directory after cloning it. See [installing Terminus plugin](https://pantheon.io/docs/terminus/plugins/#install-plugins) for details.
## Purpose
A hotfix is the only way to push code directly to Live without having to go through Dev and Test. Any damage to the source code will be the responsibility of the user. The intended use case is for critical security releases or bug fixes that need to be deployed as quickly and easily as possible. Hotfixes should be used with care and only in emergency situations. Hotfixes should be the exception, not the norm.
Currently hotfix deployments, emergency updates to test/live that skip the normal workflow and potentially undeployed code in `master`, need to be done manually and require more advanced git skills. See the [hotfix doc](https://pantheon.io/docs/hotfixes/) for details. This plugin aims to make that process easier.
## Requirements
* [Terminus](https://github.com/pantheon-systems/terminus) `1.8.0` or greater
* [git command line](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
## Commands
* `terminus hotfix:env:git-ref .` - returns the deployed git reference of the specifiied environment.
* `terminus hotfix:env:create . ` - creates a new environment for the site with code, database and files from the environment by checking out the lastest git tag associated with environment.
* `terminus hotfix:env:deploy . ` - deploy the changes from the specified environment directly to for the site , skipping the normal workflow, and rebase the changes back to the `master` branch/dev environment.
## License
MIT
## Known Issues
* `terminus hotfix:env:deploy` will fail on environments that have had a backup restored **without** a code deployment since the backup.