@vyriy/scripts
v0.4.1
Published
Shared scripts package for Vyriy projects
Readme
@vyriy/scripts
Shared scripts package for Vyriy projects.
Purpose
This package exposes reusable CDK deployment, smoke-test, and e2e script factories used by Vyriy projects.
Install
With npm:
npm install @vyriy/scriptsWith Yarn:
yarn add @vyriy/scriptsExports
apifor API smoke checksdeployfor CDK synth, diff, and deploy executiondockerfor Docker image build and push to ECRe2efor custom end-to-end scenarioskanikofor container build and push with Kanikolambdafor Lambda smoke checksuifor static UI smoke checkswebhooksfor webhook execution
Usage
Import from the package root:
import { api, deploy, docker, e2e, kaniko, lambda, ui, webhooks } from '@vyriy/scripts';Or use subpath exports:
import { api } from '@vyriy/scripts/api';
import { deploy } from '@vyriy/scripts/deploy';
import { docker } from '@vyriy/scripts/docker';
import { e2e } from '@vyriy/scripts/e2e';
import { kaniko } from '@vyriy/scripts/kaniko';
import { lambda } from '@vyriy/scripts/lambda';
import { ui } from '@vyriy/scripts/ui';
import { webhooks } from '@vyriy/scripts/webhooks';Examples
API smoke test
import { api } from '@vyriy/scripts/api';
await api();CDK deployment
import { deploy } from '@vyriy/scripts/deploy';
await deploy();Docker deployment
import { docker } from '@vyriy/scripts/docker';
await docker('./apps/api');E2E scenario
import { e2e } from '@vyriy/scripts/e2e';
await e2e(async (url) => {
await fetch(`${url}healthcheck`);
});Kaniko deployment
import { kaniko } from '@vyriy/scripts/kaniko';
await kaniko('./apps/api');Lambda smoke test
import { lambda } from '@vyriy/scripts/lambda';
await lambda('my-function');UI smoke test
import { ui } from '@vyriy/scripts/ui';
await ui();
await ui('DistributionUrl', false); // skip index.js for HTML-only outputWebhook execution
import { webhooks } from '@vyriy/scripts/webhooks';
await webhooks(['webhooks/build', 'webhooks/deploy']);