-
Notifications
You must be signed in to change notification settings - Fork 481
chore: fix the name of the sdk library so it can be auto-deploy with … #34161
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR renames the SDK create-app library to support auto-deployment via GitHub Actions. The primary change is renaming from @dotcms/create-app to sdk-create-app, along with reorganizing the library structure from libs/sdk/sdk-create-app to libs/sdk/create-app.
Key changes:
- Package name changed from
@dotcms/create-apptosdk-create-app - Directory structure simplified from
sdk-create-apptocreate-app - All configuration files updated to reflect new paths and naming
- New source files added including CLI implementation, API client, and utility functions
Reviewed changes
Copilot reviewed 5 out of 17 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| core-web/tsconfig.base.json | Updated TypeScript path aliases from @dotcms/create-app to sdk-create-app |
| core-web/libs/sdk/create-app/package.json | Changed package name from @dotcms/create-app to sdk-create-app |
| core-web/libs/sdk/create-app/project.json | Updated Nx project configuration with new name and corrected source paths |
| core-web/libs/sdk/create-app/jest.config.ts | Updated Jest display name and coverage directory path |
| core-web/libs/sdk/create-app/README.md | Updated installation command to reference new package name |
| core-web/libs/sdk/create-app/tsconfig.json | Added new base TypeScript configuration |
| core-web/libs/sdk/create-app/tsconfig.lib.json | Added library-specific TypeScript configuration |
| core-web/libs/sdk/create-app/tsconfig.spec.json | Added test-specific TypeScript configuration |
| core-web/libs/sdk/create-app/.eslintrc.json | Added ESLint configuration with console.log allowed |
| core-web/libs/sdk/create-app/src/index.ts | Added main CLI implementation with Commander.js |
| core-web/libs/sdk/create-app/src/api/index.ts | Added DotCMS API client for authentication and configuration |
| core-web/libs/sdk/create-app/src/asks.ts | Added interactive prompts for user input |
| core-web/libs/sdk/create-app/src/constants/index.ts | Added application constants and defaults |
| core-web/libs/sdk/create-app/src/errors/index.ts | Added custom error classes |
| core-web/libs/sdk/create-app/src/git/index.ts | Added Git operations for cloning templates |
| core-web/libs/sdk/create-app/src/types/index.ts | Added TypeScript type definitions |
| core-web/libs/sdk/create-app/src/utils/index.ts | Added utility functions for HTTP requests and file operations |
Comments suppressed due to low confidence (2)
core-web/libs/sdk/create-app/package.json:2
- The package name should follow dotCMS naming conventions. The naming is inconsistent with other SDK packages in the monorepo which use the @dotCMS scope (e.g., @dotcms/client). Consider using @dotcms/sdk-create-app instead of sdk-create-app to maintain consistency with the organization's package naming pattern.
core-web/libs/sdk/create-app/README.md:56 - The installation command references @dotcms/sdk-create-app but the package.json defines the name as sdk-create-app (without the @dotCMS scope). These should match. Either update package.json to use @dotcms/sdk-create-app or update this command to use sdk-create-app.
…the GHA
Proposed Changes
Checklist
Additional Info
** any additional useful context or info **
Screenshots
This PR fixes: #34054