shipitjs/shipit

call shipit programatically?

Open

#169 opened on Nov 19, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (5,331 stars) (194 forks)batch import
docshelp wanted

Description

I'd like to build a simple menu wrapper around shipit to provide a list of tasks etc (like shipit-captain but simpler)

can someone explain how I can call a shipit task from my own code?

I don't understand how the initialization happens, or how to create a shipit instance based on the shipitfile...

Contributor guide

Tech stack
javascript
Domain
developer experiencetooling
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Node.jsshipit basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue asks how to programmatically call shipit tasks. To answer, one needs to understand the shipit API and provide an example. Look at the shipit source code, specifically how shipit.run() or similar works. Consider linking to existing examples like shipit captain. The answer should explain initializing shipit from a shipitfile and invoking tasks.