Skip to content

fix: always write devcontainer.metadata label as JSON array #1199

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

Merged
abdurriq merged 3 commits into from
Apr 10, 2026
+19 −5
Merged

fix: always write devcontainer.metadata label as JSON array #1199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4f3490
fix: always write devcontainer.metadata label as JSON array
fechu Apr 9, 2026
1df0782
cleanup: remove unnecessary spaces
fechu Apr 9, 2026
3d19fac
test: add test for single metadata entry always being an array
fechu Apr 9, 2026
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
8 changes: 3 additions & 5 deletions src/spec-node/imageMetadata.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,11 +497,9 @@ export function getDevcontainerMetadataLabel(devContainerMetadata: SubstitutedCo
if (!metadata.length) {
return '';
}
const imageMetadataLabelValue = metadata.length !== 1
? `[${metadata
.map(feature => ` \\\n${toLabelString(feature)}`)
.join(',')} \\\n]`
: toLabelString(metadata[0]);
const imageMetadataLabelValue = `[${metadata
.map(feature => ` \\\n${toLabelString(feature)}`)
.join(',')} \\\n]`;
return `LABEL ${imageMetadataLabel}="${imageMetadataLabelValue}"`;
}

Expand Down
16 changes: 16 additions & 0 deletions src/test/imageMetadata.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,22 @@ describe('Image Metadata', function () {
assert.strictEqual(label.replace(/ \\\n/g, ''), `LABEL devcontainer.metadata="${JSON.stringify(expected).replace(/"/g, '\\"')}"`);
});

it('should create array label for single metadata entry (docker-compose with Dockerfile, no features)', () => {
// When there is only one metadata entry, the label should still be a JSON array.
// Regression test for https://github.com/devcontainers/cli/issues/1054
const label = getDevcontainerMetadataLabel(configWithRaw([
{
remoteUser: 'testUser',
}
]));
const expected = [
{
remoteUser: 'testUser',
}
];
assert.strictEqual(label.replace(/ \\\n/g, ''), `LABEL devcontainer.metadata="${JSON.stringify(expected).replace(/"/g, '\\"')}"`);
});

it('should merge metadata from devcontainer.json and features', () => {
const merged = mergeConfiguration({
configFilePath: URI.parse('file:///devcontainer.json'),
Expand Down