Skip to content
This repository was archived by the owner on Feb 17, 2025. It is now read-only.

fix: primitive metadata values cannot be loaded in jsii languages #121

Merged
merged 5 commits into from
Jan 8, 2025
Merged

fix: primitive metadata values cannot be loaded in jsii languages #121

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
628b5b7
mid work
iliapolo Jan 8, 2025
737a360
Update version.json
rix0rrr Jan 8, 2025
866c29e
Update metadata-schema.ts
rix0rrr Jan 8, 2025
888a768
chore: self mutation
invalid-email-address Jan 8, 2025
89f55f4
Merge branch 'main' into epolon/allow-primitive-metadata-entries
mergify[bot] Jan 8, 2025
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
2 changes: 1 addition & 1 deletion .projen/tasks.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 11 additions & 1 deletion lib/cloud-assembly/metadata-schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,14 +260,24 @@ export type LogicalIdMetadataEntry = string;
*/
export type StackTagsMetadataEntry = Tag[];

/**
* Any other type of metadata entry
*
* This could probably be changed to `any`, but it's safer not
* to do so right now.
* See https://github.com/cdklabs/cloud-assembly-schema/pull/121.
*/
export type PrimitiveType = boolean | number | string;
Copy link
Contributor Author

@iliapolo iliapolo Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really wanted to put a comment here, but its just too nasty to explain. An entire PR is needed to understand why this is necessary.

Copy link

@samson-keung samson-keung Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link the PR as a code comment? Just an idea.


/**
* Union type for all metadata entries that might exist in the manifest.
*/
export type MetadataEntryData =
| AssetMetadataEntry
| LogMessageMetadataEntry
| LogicalIdMetadataEntry
| StackTagsMetadataEntry;
| StackTagsMetadataEntry
| PrimitiveType;

/**
* Type of artifact metadata entry.
Expand Down
6 changes: 5 additions & 1 deletion schema/cloud-assembly.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,11 @@
}
},
{
"type": "string"
"type": [
"string",
"number",
"boolean"
]
},
{
"description": "Free form data."
Expand Down
4 changes: 2 additions & 2 deletions schema/version.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"schemaHash": "f0ccc3212331af8a1c75830878d218fd667e5957063831be3b5bfd803b25f0cc",
"schemaHash": "bf762e5da559c685e06892ef65fdfc33d1c4bd53d4eb07d4a326d476ac58ae25",
"revision": 39
}
}
Loading