{"id":13505634,"url":"https://github.com/pahud/awscdk-jsii-template","last_synced_at":"2025-03-30T00:31:17.327Z","repository":{"id":55544151,"uuid":"270672598","full_name":"pahud/awscdk-jsii-template","owner":"pahud","description":"JSII construct library template for AWS CDK","archived":true,"fork":false,"pushed_at":"2020-12-22T19:54:07.000Z","size":750,"stargazers_count":17,"open_issues_count":4,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-20T15:03:34.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pahud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-08T13:08:48.000Z","updated_at":"2024-12-17T18:00:14.000Z","dependencies_parsed_at":"2022-08-15T02:50:57.332Z","dependency_job_id":null,"html_url":"https://github.com/pahud/awscdk-jsii-template","commit_stats":null,"previous_names":[],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pahud%2Fawscdk-jsii-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pahud%2Fawscdk-jsii-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pahud%2Fawscdk-jsii-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pahud%2Fawscdk-jsii-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pahud","download_url":"https://codeload.github.com/pahud/awscdk-jsii-template/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246262490,"owners_count":20749170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T00:01:10.896Z","updated_at":"2025-03-30T00:31:12.309Z","avatar_url":"https://github.com/pahud.png","language":"TypeScript","funding_links":[],"categories":["Scaffolding"],"sub_categories":["Multi-accounts setup"],"readme":"[![awscdk-jsii-template](https://img.shields.io/badge/built%20with-awscdk--jsii--template-blue)](https://github.com/pahud/awscdk-jsii-template)\n\n\n# Welcome to `awscdk-jsii-template`\n\nThis repository template helps you generate JSII construct library for AWS CDK and aims to simplify\nthe process to develop, build, test and eventually publish your AWS CDK construct lib to `npmjs` and `pipy`.\n\n\n## Directories in this template\n\n- **src** - all the typescript source code under this directory\n- **test** - unit tests and integ tests\n- **lib** - will be auto-generated from the `src` when you run `yarn build`\n\n\n## Confiuguration\n\n1. customize your `.projenrc.js`\n1. run `npx projen` to project generate assets including the `LICENSE`, `version.json`, `package.json` and `.github/workflows` from `.projenrc.js`.\nAt this moment, your initial `version` should be `0.0.0`.\n2. `yarn install` to install all required npm packages\n\nYou can run the commands above like this:\n```sh\n$ npx projen \u0026\u0026 yarn install\n```\n\n\u003eFrom now on, we will refer to this command as pj. Every time you modify .projenrc.js, just run pj.\n\n\u003ePut this in your shell profile: alias pj='npx projen \u0026\u0026 yarn install'\n\n\n\n## Integration tests\n\n1. run `yarn watch` in a seperate terminal\n2. edit `test/integ.api.ts`\n3. Run `cdk diff` and `cdk deploy` to ensure it deploys with no error in your real aws environment.\n\n```bash\ncdk --app 'test/integ.api.js' diff\ncdk --app 'test/integ.api.js' deploy\n```\n\n4. validate the stack\n\n## Unit tests\n\n1. edit `test/*.test.ts`\n2. run `yarn test`\n\n\n## run `yarn build` to generate the `lib` directory\n\nIf `yarn test` is doing great with no error. Run `yarn build` to generate the `lib` and other assets.\n\n## commit your changes to local repository\n\n```sh\n$ git commit -am \"chore(release): initial commit for the first release\" \n```\n\n\n## bump the version and push to your repository\n\nTo bump a specific release version number, i.e. `v0.1.0`\n```sh\n$ yarn bump --release-as v0.1.0\n```\nor simply bump the minor version from `version.json`, in which case the version will bump from `0.0.0` to `0.0.1`\n\n```sh\n$ yarn bump\n```\n\nand `git push` with the tags\n\n```sh\n$ git push --follow-tags origin master\n```\n\nOr just:\n\n```sh\n# this equals to `arn bump \u0026\u0026 git push --follow-tags origin master`, see package.json\n$ yarn release\n```\n\nIf you push successfully, go to your the `Actions` in your github repository, make sure the `build` and `release` workflows run successfully.\n\n\n## Projen\n\nThis template leverages the [eladb/projen](https://github.com/eladb/projen) by [Elad Ben-Israel](https://github.com/eladb). Check it out for more detials and usages for the `projen` command.\n\n## Projects using this Template\n- [aws-fargate-fast-autoscaler](https://github.com/aws-samples/aws-fargate-fast-autoscaler)\n- [cdk-eks-spotblocks](https://github.com/pahud/cdk-eks-spotblocks)\n- [cdk-elasticsearch-monitor](https://github.com/jialechan/cdk-elasticache-monitor)\n- [cdk-fargate-express](https://github.com/pahud/cdk-fargate-express)\n- [cdk-gitlab-runner](https://github.com/guan840912/cdk-gitlab-runner)\n- [cdk-serverless-lamp](https://github.com/aws-samples/cdk-serverless-lamp)\n- [cdk-soca](https://github.com/pahud/cdk-soca)\n- [cdk-spot-one](https://github.com/pahud/cdk-spot-one)\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpahud%2Fawscdk-jsii-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpahud%2Fawscdk-jsii-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpahud%2Fawscdk-jsii-template/lists"}