feat(cli): add git repository support for custom init templates #820
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: github-actions <[email protected]>
Signed-off-by: github-actions <[email protected]>
…positories that users can select templates from using --template-path param
Signed-off-by: github-actions <[email protected]>
…ased on CR feedback
Signed-off-by: github-actions <[email protected]>
Signed-off-by: github-actions <[email protected]>
…fy implies constraint works correctly
Signed-off-by: github-actions <[email protected]>
Signed-off-by: github-actions <[email protected]>
Co-authored-by: Ian Hou <[email protected]>
Signed-off-by: github-actions <[email protected]>
…guage specified, and fixed post-install for CDK languages
Signed-off-by: github-actions <[email protected]>
rohang9000
requested a deployment
to
integ-approval
GitHub Actions
Waiting
aws-cdk-automation
requested a deployment
to
integ-approval
GitHub Actions
Waiting
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #820 +/- ##
==========================================
- Coverage 82.60% 80.93% -1.68%
==========================================
Files 64 64
Lines 9465 9075 -390
Branches 1106 1108 +2
==========================================
- Hits 7819 7345 -474
- Misses 1612 1698 +86
+ Partials 34 32 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
iankhou
requested changes
Aug 28, 2025
| 'template-path': { type: 'string', desc: 'Path to a specific template within a multi-template repository', requiresArg: true }, | ||
| }, | ||
| implies: { 'template-path': 'from-path' }, |
There was a problem hiding this comment.
This should be replaced by a check that ensures that from-path or from-git-url was also used.
| @@ -84,16 +91,27 @@ export async function cliInit(options: CliInitOptions) { | |||
| const generateOnly = options.generateOnly ?? false; | |||
| const workDir = options.workDir ?? process.cwd(); | |||
|
|
|||
| // Validate that if template-path is provided, exactly one custom template source must be provided | |||
| if (options.templatePath && !options.fromPath && !options.fromGitUrl) { | |||
| throw new ToolkitError('--template-path can only be used with --from-path or --from-git-url'); | |||
There was a problem hiding this comment.
why not use a check in yargs instead? In general, try to catch problems as early as you can.
rohang9000
force-pushed
the
feat/git-repository-support-for-custom-templates
branch
from
9b3ea2d to
5437650
Compare
rohang9000
requested a deployment
to
integ-approval
GitHub Actions
Waiting
Signed-off-by: github-actions <[email protected]>
aws-cdk-automation
requested a deployment
to
integ-approval
GitHub Actions
Waiting
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated code for
cdk initcommand to handle custom templates from Git repository sources. This is compatible with the existing--languageand--template-pathflags. The--from-git-urlflag was added to clone a Git URL that is passed in by the user, clones the repository, extracts the specified template files and initializes new project with them. Thecdk initfunctionality of creating new local Git repo to track changes, making initial commit, and installing project dependencies is maintained.Fixes #
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license