@mythicdrops/github-cdkactions

github-cdkactions

cdkactions for use by MythicDrops GitHub Actions workflows.

Usage

Follow the setup instructions for cdkactions and setup your main.ts like below:

import { Construct } from "constructs";
import { App, Stack } from "cdkactions";
import {
  createGradlePluginPullRequestWorkflow,
  createGradlePluginPrepareForReleaseWorkflow,
  createGradlePluginReleaseWorkflow
} from "@mythicdrops/github-cdkactions";

export class MyStack extends Stack {
  constructor(scope: Construct, id: string) {
    super(scope, id);

    // define workflows here
    createGradlePluginPullRequestWorkflow(this);
    createGradlePluginPrepareForReleaseWorkflow(this);
    createGradlePluginReleaseWorkflow(this);
  }
}

const app = new App();
new MyStack(app, 'cdk');
app.synth();

Commands

To run github-cdkactions, use:

npm start # or yarn start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Code quality is set up with prettier, eslint, and husky.

Jest

Jest tests are set up to run with npm test or yarn test.

Bundle Analysis

size-limit is set up to calculate the real cost of this library with npm run size and visualize the bundle with npm run analyze.

Rollup

TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.

TypeScript

tsconfig.json is set up to interpret dom and esnext types, as well as react for jsx. Adjust according to your needs.

Continuous Integration

GitHub Actions

Two actions are added by default:

• main which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
• size which comments cost comparison of your library on every pull request using size-limit

Optimizations

Please see the main tsdx optimizations docs. In particular, know that you can take advantage of development-only optimizations:

// ./types/index.d.ts
declare var __DEV__: boolean;

// inside your code...
if (__DEV__) {
  console.log("foo");
}

You can also choose to install and use invariant and warning functions.

Module Formats

CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in package.json and dist/index.js accordingly. Please report if any issues are found.

Named Exports

Per Palmer Group guidelines, always use named exports.

Publishing

This project uses semantic-release in order to perform releases.