Skip to content

alma-cdk/construct-library

Repository files navigation

Alma CDK Construct Library

Stability: Experimental Versioning: SemVer 2.0.0 release Quality Gate Status Coverage


Custom Projen Project Type to manage all the alma-cdk/* CDK construts.

Installation

  1. Install with npm:

    npm i -D @alma-cdk/construct-library
  2. If existing project, install npm i -D projen@0.99.21 or newer

  3. Import the custom Projen project type:

    - import { AwsCdkConstructLibrary } from 'projen/lib/awscdk';
    + import { cdk } from "projen";
    + import { AlmaCdkConstructLibrary } from "@alma-cdk/construct-library";
  4. Initialize and define (at least) minimum required configuration:

    const project = new AlmaCdkConstructLibrary({
      name: "<SCOPE>/<PACKAGE_NAME>",
      author: "<AUTHOR_ORGANIZATION_NAME>",
      authorAddress: "<AUTHOR_ORGANIZATION_EMAIL>",
      description: "<PACKAGE_DESCRIPTION>",
      repositoryUrl: "https://<GIT_URL>.git",
      stability: cdk.Stability.EXPERIMENTAL, // or STABLE or DEPRECATED
      majorVersion: 0, // 1, 2, ...
      releaseEnvironment: "production",
    });
    
    project.synth();
  5. Fnm use 24

  6. Install pnpm

  7. Run projen with pnpm:

    pnpm exec projen
  8. Ensure correct Node version: fnm use

  9. Remove old node_modules, yarn.lock, and/or package-lock.json files

  10. Reinstall everything with pnpm install

About

Projen custom project to build Alma CDK construct libraries

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors