Skip to content

Commit b584e60

Browse files
authored
Merge pull request #479 from dappnode/feat/strip-compose-version
feat(compose): add opt-in flag to strip top-level version from compose
2 parents 6ad9419 + 94ac79c commit b584e60

15 files changed

Lines changed: 114 additions & 15 deletions

File tree

‎src/commands/build/handler.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ export async function buildHandler({
2424
variants_dir_name: variantsDirName = defaultVariantsDirName,
2525
variants,
2626
skip_compose_validation: skipComposeValidation,
27+
strip_compose_version: stripComposeVersion,
2728
arch,
2829
// Global options
2930
dir = defaultDir,
@@ -65,9 +66,9 @@ export async function buildHandler({
6566
skipUpload,
6667
composeFileName,
6768
requireGitData,
68-
deleteOldPins,
6969
variantsDirPath,
7070
skipComposeValidation,
71+
stripComposeVersion,
7172
packagesToBuildProps
7273
};
7374

‎src/commands/build/index.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ export const build: CommandModule<CliGlobalOptions, BuildCommandOptions> = {
5959
description: `Skip the Dappnode compose validation step`,
6060
type: "boolean"
6161
},
62+
strip_compose_version: {
63+
alias: "strip-compose-version",
64+
description: `For testing only: strip the obsolete top-level Compose version`,
65+
type: "boolean",
66+
default: false
67+
},
6268
arch: {
6369
description: `Specify the architecture to build for: "linux/amd64" or "linux/arm64"`,
6470
type: "string"

‎src/commands/build/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export interface BuildCommandOptions extends CliGlobalOptions {
1313
variants?: string;
1414
all_variants?: boolean;
1515
skip_compose_validation?: boolean;
16+
strip_compose_version?: boolean;
1617
arch?: string;
1718
}
1819

‎src/commands/publish/handler.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export async function publishHandler({
2828
require_git_data: requireGitData,
2929
delete_old_pins: deleteOldPins,
3030
skip_compose_validation: skipComposeValidation,
31+
strip_compose_version: stripComposeVersion,
3132
// Global options
3233
dir = defaultDir,
3334
compose_file_name: composeFileName = defaultComposeFileName,
@@ -76,12 +77,12 @@ export async function publishHandler({
7677
uploadTo,
7778
userTimeout,
7879
requireGitData,
79-
deleteOldPins,
8080
developerAddress,
8181
githubRelease,
8282
verbosityOptions,
8383
variantsDirPath,
8484
skipComposeValidation,
85+
stripComposeVersion,
8586
packagesToBuildProps: getPackagesToBuildProps({
8687
allVariants: Boolean(allVariants),
8788
commaSeparatedVariants: variants,

‎src/commands/publish/index.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ export const publish: CommandModule<CliGlobalOptions, PublishCommandOptions> = {
8888
alias: "skip-compose-validation",
8989
description: `Skip the Dappnode compose validation step`,
9090
type: "boolean"
91+
},
92+
strip_compose_version: {
93+
alias: "strip-compose-version",
94+
description: `For testing only: strip the obsolete top-level Compose version`,
95+
type: "boolean",
96+
default: false
9197
}
9298
},
9399

‎src/commands/publish/types.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ export interface PublishCommandOptions extends CliGlobalOptions {
1717
variants?: string;
1818
all_variants?: boolean;
1919
skip_compose_validation?: boolean;
20+
strip_compose_version?: boolean;
2021
}

‎src/files/compose/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ export { getComposePackageImages } from "./getComposePackageImages.js";
33
export { getComposePath } from "./getComposePath.js";
44
export { parseComposeUpstreamVersion } from "./parseComposeUpstreamVersion.js";
55
export { readCompose } from "./readCompose.js";
6+
export { stripComposeVersion } from "./stripComposeVersion.js";
67
export { updateComposeImageTags } from "./updateComposeImageTags.js";
78
export { writeCompose } from "./writeCompose.js";
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { Compose } from "@dappnode/types";
2+
3+
/**
4+
* Remove the obsolete top-level version from a parsed Compose object.
5+
*
6+
* Compose still declares version as required in @dappnode/types, so use
7+
* Reflect.deleteProperty until that shared type makes the property optional.
8+
*/
9+
export function stripComposeVersion(compose: Compose): void {
10+
Reflect.deleteProperty(compose, "version");
11+
}

‎src/tasks/buildAndUpload/getFileValidationTask.ts‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,53 @@ import {
77
validateDappnodeCompose,
88
validateNotificationsSchema
99
} from "@dappnode/schemas";
10-
import { getComposePath } from "../../files/index.js";
10+
import {
11+
getComposePath,
12+
stripComposeVersion as removeComposeVersion
13+
} from "../../files/index.js";
1114
import { CliError } from "../../params.js";
1215

1316
export function getFileValidationTask({
1417
packagesToBuildProps,
15-
skipComposeValidation
18+
skipComposeValidation,
19+
stripComposeVersion
1620
}: {
1721
packagesToBuildProps: PackageToBuildProps[];
1822
skipComposeValidation?: boolean;
23+
stripComposeVersion?: boolean;
1924
}): ListrTask<ListrContextBuild> {
2025
return {
2126
title: `Validate files`,
2227
task: async () =>
2328
await validatePackageFiles({
2429
packagesToBuildProps,
25-
skipComposeValidation
30+
skipComposeValidation,
31+
stripComposeVersion
2632
})
2733
};
2834
}
2935

3036
async function validatePackageFiles({
3137
packagesToBuildProps,
32-
skipComposeValidation
38+
skipComposeValidation,
39+
stripComposeVersion
3340
}: {
3441
packagesToBuildProps: PackageToBuildProps[];
3542
skipComposeValidation?: boolean;
43+
stripComposeVersion?: boolean;
3644
}): Promise<void> {
3745
for (const pkgProps of packagesToBuildProps)
38-
await validateVariantFiles(pkgProps, skipComposeValidation);
46+
await validateVariantFiles(
47+
pkgProps,
48+
skipComposeValidation,
49+
stripComposeVersion
50+
);
3951
}
4052

4153
async function validateVariantFiles(
4254
pkgProps: PackageToBuildProps,
43-
skipComposeValidation?: boolean
55+
skipComposeValidation?: boolean,
56+
stripComposeVersion?: boolean
4457
): Promise<void> {
4558
const {
4659
manifest,
@@ -75,8 +88,9 @@ async function validateVariantFiles(
7588
// Validate notifications schema
7689
if (notifications) validateNotificationsSchema(notifications);
7790

78-
// Validate setup wizard schema
79-
if (setupWizard) validateSetupWizardSchema(setupWizard);
91+
// Keep version available for the Dappnode validation above. Stripping is
92+
// opt-in while support for versionless Compose files is being tested.
93+
if (stripComposeVersion) removeComposeVersion(compose);
8094
}
8195

8296
function validatePackageName(name: string): void {

‎src/tasks/buildAndUpload/index.ts‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,23 @@ export function buildAndUpload({
2828
dir,
2929
variantsDirPath = defaultVariantsDirName,
3030
packagesToBuildProps,
31-
skipComposeValidation
31+
skipComposeValidation,
32+
stripComposeVersion
3233
}: BuildAndUploadOptions): ListrTask<ListrContextBuild>[] {
3334
const buildTimeout = parseTimeout(userTimeout);
3435

35-
// Release upload. Use function for return syntax
3636
const releaseUploaderProvider = cliArgsToReleaseUploaderProvider({
3737
uploadTo,
3838
contentProvider
3939
});
4040
const releaseUploader = getReleaseUploader(releaseUploaderProvider);
4141

4242
return [
43-
getFileValidationTask({ packagesToBuildProps, skipComposeValidation }),
43+
getFileValidationTask({
44+
packagesToBuildProps,
45+
skipComposeValidation,
46+
stripComposeVersion
47+
}),
4448
getVerifyConnectionTask({ releaseUploader, skipUpload }),
4549
getReleaseDirCreationTask({ packagesToBuildProps }),
4650
getFileCopyTask({

0 commit comments

Comments
 (0)