shipitjs/shipit

call shipit programatically?

Open

#169 geöffnet am 19. Nov. 2017

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (5.331 Stars) (194 Forks)batch import
docshelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Node.jsshipit basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.