entria / entria-deploy

Entria Deploy helpers

Entria Deploy

• Gives a list of paths that changed from a compare url, example below:

https://github.com/sibelius/monorepo-101/compare/1662e1d...0edb974

• Check if a determined path has changed from a compare url

How to install

yarn add @entria/deploy --dev

Usage with CircleCI

Add CIRCLECI_COMPARE_URL environment to your .circleci/config.yml

environment:
    CIRCLECI_COMPARE_URL: << pipeline.project.git_url >>/compare/<< pipeline.git.base_revision >>...<<pipeline.git.revision>>

Get files to be tested by jest

TESTFILES=$(yarn entria-deploy changes $CIRCLECI_COMPARE_URL)
yarn jest --maxWorkers=3 --coverage --forceExit --ci

Check if you need to deploy some package

SHOULD_BUILD=$(yarn entria-deploy hasChanged $CIRCLECI_COMPARE_URL packages/api)
if [ "$SHOULD_BUILD" == false ]; then
  circleci-agent step halt
fi

Usage in JavaScript/TypeScript

import { shouldDeployPackage, changedPaths } from '@entria/deploy';

// it should be another compare url, from Travir of instance
const shouldDeploy = shouldDeployPackage(process.cwd())(process.env.CIRCLE_COMPARE_URL);

if (shouldDeploy('packages/server') {
    console.log('deploy server');
}

const allchanges = await changedPaths(process.env.CIRCLE_COMPARE_URL);
console.log('all changes');

entria-deploy's Issues

Add cli option for packages directory name

Hey, nice work @sibelius 👍 , as always, I can find your contributions whenever I go looking to solve a problem.

I have a proposal. I am looking to solve a situation in which I need to trigger a workflow on directory changes for bit.dev. Here is need..

Basically I won't be using changes to the packages directory to trigger the flow. So my proposal is to allow a command line option [-d, --dir] <folder-name> to the cli to swap out the name for the default folder name packages.

Usage:

  entria-deploy components --dir bit-staging

would you accept a PR?

btw, I saw comments about pipelines, but we have a self-hosted circle server so can't use that.

handle missing CIRCLE_COMPARE_URL

sometimes CircleCI does not provide a CIRCLE_COMPARE_URL

My idea in this case is to diff against the last merge, so we know which changed after a pull request is merged

get packages list from package.json workspaces or lerna info

handle dependencies among packages inside a lerna/yarn workspaces monorepo

yarn workspaces info could be a good start

Package is not deployed to npm/yarn

When I run yarn global add @entria/deploy (command from docs) I get

error An unexpected error occurred: "https://registry.yarnpkg.com/@entria%2fdeploy: Not found".

Also search on yarnpkg shows not result.

Are you about to deploy this package or should I use some another solution?