projen VS awesome-awscdk-project

This project uses AWS CDK as infrastructure as code solution. To maintain project configuration files efficiently, the project structure is generated using projen:

I recommend visiting the github page for projen and flicking through the documentation as I won't do it justice. Projen aims to:

cdk-django uses projen for maintaining the changelog and bumping versions and publishing to npm. It is popular among developers in the CDK community and is a really awesome tool since it basically uses one file (.projenrc.ts) to configure your entire repo, including files like tsconfig.json, package.json, and even GitHub Action workflows. It has a lot of configuration options, but I'm using it in a pretty simple way. It generates a new release and items to the changelog when I manually trigger a GitHub Action.

I will give you step-by-step instructions to create your very first AWS Organization with the AWS CDK and the help of projen and cdk-organizations. You only need already an AWS Account created which is not a member or management account of another AWS Organization.

If you go down that route you should use Projen to maintain the dependencies.

An Open Source CDK Community project which I find super interesting. It is doing cherry-picking from AWS Amplify UI and AWS CDK for deployment. I do that in my private projects as well for example https://github.com/senjuns/senjuns. I think the author could enhance/simplify its repo even more by using https://github.com/projen/projen for the project setup.

That said - https://github.com/firecracker-microvm/firecracker and https://github.com/bottlerocket-os/bottlerocket are interesting, and while AWS CDK is very AWS specific, the underlying jsii https://github.com/aws/jsii and projen https://github.com/projen/projen/issues are fundamental services.

The documentation for the classes of the bundled project types is at https://github.com/projen/projen/. In this documentation, you can see that the property github includes a mergify entry, which will define if the Mergify configuration is used. The default if the github entry is not specified, is that it will be included. So in our test, we can check that this configuration is not in place, after creating a project with the mandatory parameters.

const { JsiiProject } = require('projen'); const project = new JsiiProject({ author: 'Adam Author', authorAddress: '[email protected]', defaultReleaseBranch: 'main', name: 'awesome-awscdk-project', repositoryUrl: 'https://github.com/adamauthor/awesome-awscdk-project.git', // deps: [], /* Runtime dependencies of this module. */ // description: undefined, /* The description is just a string that helps people understand the purpose of the package. */ // devDeps: [], /* Build dependencies for this module. */ // packageName: undefined, /* The "name" in package.json. */ // projectType: ProjectType.UNKNOWN, /* Which type of project this is (library/app). */ // release: undefined, /* Add release management to this project. */ }); project.synth();