shipitjs/shipit

call shipit programatically?

Open

#169 opened on Nov 19, 2017

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

Repository metrics

Stars
 (5,331 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Search for programmatic usage patterns in the shipit source code or API documentation. Provide a small code example demonstrating how to require shipit, load a shipitfile, and run a task.
Tech stack
javascriptnodejs
Domain
developer experienceapicli
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.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsshipit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65