shipitjs/shipit

How to listen an event and run a remote command (blocking)?

Open

#271 opened on Jun 12, 2020

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

Description

The suggested solution is this:

  shipit.blTask('app:build', async () => {
    await shipit.remote(`cd ${shipit.releasePath} && yarn install && yarn build`);
  });

  shipit.on('updated', () => {
    shipit.start('app:build');
  });

But how to avoid the app:build task (which make sense only during deploy or rollback, using releasePath)?

  // Not blocking - NOT WORKING
  shipit.on('updated', async () => {
    await shipit.remote(`cd ${shipit.releasePath} && yarn install && yarn build`);
  });

  // Not blocking - NOT WORKING
  shipit.on('updated', () => {
    return shipit.remote(`cd ${shipit.releasePath} && yarn install && yarn build`);
  });

Contributor guide

Tech stack
javascriptnodejs
Domain
devops
Issue type
research
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.
clear
Prerequisites
JavaScript async/awaitshipit event system basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the shipit event system to determine if event listeners support async functions and returning promises. Check the shipit.remote function signature and whether it returns a promise. Look at existing examples in the repository or documentation for blocking remote commands. The issue's suggested workaround uses a blocking task; evaluate if that is the intended pattern or if there is an alternative.