This repository is a collection of shared AWS CDK constructs authored by the Treedom development team. Each package contained in the packages folder contains a different set of constructs and can be installed separately.
Made with ❤️ at 
A package containing CDK constructs for Datadog integration.
A package containing CDK constructs for SQS and Lambda integration.
To install a specific package, use npm:
npm install @treedom/cdk-constructs-datadog
# or
npm install @treedom/cdk-constructs-sqs-lambdaPlease refer to the individual package README files for detailed usage instructions and API references.
- Node.js (version specified in the root package.json)
- npm
-
Clone the repository:
git clone [email protected]:treedomtrees/cdk-constructs.git cd cdk-constructs
-
Install dependencies:
npm install
npm run lint: Run ESLint on all TypeScript files in the packages.
Note: Build and test scripts are package-specific. Refer to individual package.json files for details.
- Create a new branch for your feature or bug fix.
- Make your changes in the appropriate package(s).
- Write or update tests as necessary.
- Run
npm run lintfrom the root directory to ensure your code follows the project's coding standards. - Navigate to the specific package directory and run
npm run buildto build the package. - Run
npm run testin the package directory to ensure all tests pass. - Commit your changes and push to your branch.
- Create a pull request for review.
Ensure you have the necessary permissions to publish to the @treedom organization on npm.
To release a new package version, create a release and tag it with a tag following the format: package/vX.X.X. Examples sqs-lambda/v1.0.0. The new tag creation will trigger this pipeline
You can use this link to have a release template: RELEASE TEMPLATE
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT License. See the LICENSE file for details.
We welcome contributions from the community! Please read our contributing guidelines for details on our code of conduct and the process for submitting pull requests.
For support, please open an issue in the GitHub repository. For urgent matters, you can contact the Treedom IT team at [email protected].
We invite all developers who use Treedom's open-source code to support our mission of sustainability by planting a tree with us. By contributing to reforestation efforts, you help create a healthier planet and give back to the environment. Visit our Treedom Open Source Forest to plant your tree today and join our community of eco-conscious developers.
Additionally, you can integrate the Treedom GitHub badge into your repository to showcase the number of trees in your Treedom forest and encourage others to plant new ones. Check out our integration guide to get started.
Together, we can make a lasting impact! 🌍💚