Skip to main content

A sample JSII construct lib for AWS CDK

Project description

Welcome to awscdk-jsii-template

This repository template helps you generate JSII construct library for AWS CDK.

Confiuguration

  1. customize your .projenrc.js
  2. run npx projen to generate the package.json and .github/workflows from .projenrc.js
  3. yarn install to install all required npm packages

Integration tests

  1. run yarn watch in a seperate terminal
  2. edit test/integ.api.ts
  3. cdk diff and cdk deploy
cdk --app 'test/integ.api.js' diff
cdk --app 'test/integ.api.js' deploy
  1. validate the stack

Unit tests

  1. edit test/*.test.ts
  2. run yarn test

Usage

Command Description
yarn install Install dependencies
yarn compile Compile to JavaScript
yarn watch Watch for changes and compile
yarn test Run tests
yarn run package Create dist with bundles for all languages
yarn build Compile + test + package
yarn bump Bump a new version (based on conventional commits)
yarn compat Run API compatibility check against latest

GitHub Workflows

  • Build: when a PR is created/updated, runs yarn build
  • Release: yarn build and publish to all package managers for every commit to master (ignore if current version is already released).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cdk-serverless-api, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size cdk_serverless_api-0.0.1-py3-none-any.whl (20.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cdk-serverless-api-0.0.1.tar.gz (19.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page