pling-cli

Pling Workflow CLI

What is the main idea 💡?

Pling consider that every development must to be directly attached to a Github Issue, providing all information about what have to be developed.

To isolate this work the CLI always create a branch from a stabilized environment such (pre production) to avoid conflict with other developer stuff.

How does the CLI Platform Work 🥋

TBD

Requirements 🎟

The Pling CLI app run using Node.js v6.11.0.

You can develop using any version of Node you'd like, but your code has to run on Node v6.10.2. You can accomplish this by developing on your preferred version and then transpiling with Babel (or similar).

For NVM on Mac (via homebrew):

brew install nvm
nvm install v6.10.2

Quick Setup Guide 🔧

Be sure to check the Requirements before you start! Also, we recommend the Tutorial for a more thorough introduction.

# install the CLI globally
npm install -g pling-cli

Local Project Structure 🌍

Source structure.

.
├── README.md
├── LICENSE
├── .gitignore
├── package.json
├── lib
│   └── helpMessage.js
|   └── utils.js
├── bin
│   ├── deploy.js
│   ├── fix-sync-issue.js
│   ├── help.js
│   ├── init.js
|   ├── start-issue.js
|   ├── sync-issue.js
|   ├── version.js
└── node_modules
    ├── ...
    └── ...

Get Help! ⛑

You can get help emailing [e-mail].

Using it 👨‍

After doing npm install -g pling-cli, go to the project you want to work on and do the steps below:

1. Fork the project you want to work on
2. Clone the forked project: git clone [e-mail]:<YOUR_USER_NAME>/<PROJECT>.git
3. Access the folder: cd <PROJECT>
4. Add pling-cli workflow to the project: pling-cli init
5. Install dependencies: npm install
6. Run the project: TBD

Commands 📚

💡 remove the '<' and '>' from the command replacing it with your issue number eg: 31 without #.

# add pling-cli workflow to the current project
$ pling-cli init

# start a new work issue from a branch called pp that we call by (pre production).
$ pling-cli start <github_issue_number>

# creates a new issue (branch) from "pp" including commits from another issue (branch)
# that you have locally done (created) before, usually used to continue a work that you have completed.
$ pling-cli start <issue_number> <base_issue_number>

# sync the current issue branch with pp.
$ pling-cli sync

# sync the current issue (branch) with another issue (branch)
# that you have locally done (created) before, usually used to continue a work that you have completed.
$ pling-cli sync <base_issue_number>

# creates a new PR on the desided enviroment (master, hml, pp).
$ pling-cli deploy <place_to_deploy>

# creates a new PR on the desided enviroment (master, hml, pp) when the current issue (branch) has forked from a base issue (branch).
$ pling-cli deploy <place_to_deploy> <base_issue_number>`

# command list
$ pling-cli --help

Contributing 💙

Clone the project to get confortable to make pull requests.

After doing the changes, use the command bellow at the pling-workflow-cli root to install the package globally with the changes you've made to test in another repository the pling-cli package. $ npm install -g .

You can also submit your requests through the issues panel.

We just released it, so we appreciate for any suggestions.