Skip to content

chore(workflow): force trim the description for packaging #842

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.

Sign up for GitHub

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

Open
shikha372 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(workflow): force trim the description for packaging #842

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion projenrc/type-package.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@ export class CloudFormationTypeProject extends Component {

new License(project, { spdx });

const description = options.type.Description ?? `Constructs for ${typeName}`;
// Force trim the description to keep the char limit as per core-metadata specification for python packaging
// Ref: https://packaging.python.org/en/latest/specifications/core-metadata/#summary
const description: string = options.type.Description ? options.type.Description.slice(0, 512) : `Constructs for ${typeName}`;

const npmName = `${npmScope}/${typeNameKebab}`;

new Readme(project, {
Expand Down