diff --git a/packages/integration/config.d.ts b/packages/integration/config.d.ts index 07155944b3..bd5267ab3d 100644 --- a/packages/integration/config.d.ts +++ b/packages/integration/config.d.ts @@ -64,6 +64,7 @@ export interface Config { }[]; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; @@ -100,6 +101,7 @@ export interface Config { appPassword?: string; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; @@ -118,6 +120,7 @@ export interface Config { appPassword: string; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; @@ -151,6 +154,7 @@ export interface Config { apiBaseUrl?: string; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; @@ -190,6 +194,7 @@ export interface Config { password?: string; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; @@ -253,10 +258,6 @@ export interface Config { */ allowedInstallationOwners?: string[]; }>; - /** - * PGP signing key for signing commits. - */ - commitSigningKey?: string; }>; /** Integration configuration for GitLab */ @@ -295,6 +296,7 @@ export interface Config { baseUrl?: string; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; @@ -379,6 +381,7 @@ export interface Config { password?: string; /** * PGP signing key for signing commits. + * @visibility secret */ commitSigningKey?: string; }>; diff --git a/packages/integration/report.api.md b/packages/integration/report.api.md index 0f7c6dd00b..e44b02851c 100644 --- a/packages/integration/report.api.md +++ b/packages/integration/report.api.md @@ -269,7 +269,7 @@ export type BitbucketIntegrationConfig = { token?: string; username?: string; appPassword?: string; - signingKey?: string; + commitSigningKey?: string; }; // @public diff --git a/packages/integration/src/bitbucket/config.ts b/packages/integration/src/bitbucket/config.ts index 195e7302e8..6939034e7d 100644 --- a/packages/integration/src/bitbucket/config.ts +++ b/packages/integration/src/bitbucket/config.ts @@ -66,7 +66,7 @@ export type BitbucketIntegrationConfig = { /** * Signing key for commits */ - signingKey?: string; + commitSigningKey?: string; }; /** @@ -105,7 +105,7 @@ export function readBitbucketIntegrationConfig( token, username, appPassword, - signingKey: config.getOptionalString('signingKey'), + commitSigningKey: config.getOptionalString('commitSigningKey'), }; } diff --git a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.ts b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.ts index 09fff190ce..e52eb50976 100644 --- a/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.ts +++ b/plugins/scaffolder-backend-module-bitbucket/src/actions/bitbucket.ts @@ -388,8 +388,8 @@ export function createPublishBitbucketAction(options: { : config.getOptionalString('scaffolder.defaultAuthor.email'), }; const signingKey = - integrationConfig.config.signingKey ?? - config.getOptionalString('scaffolder.defaultSigningKey'); + integrationConfig.config.commitSigningKey ?? + config.getOptionalString('scaffolder.defaultCommitSigningKey'); if (signCommit && !signingKey) { throw new Error( 'Signing commits is enabled but no signing key is provided in the configuration', diff --git a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.test.ts b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.test.ts index 45d92449bc..1c5cd57a14 100644 --- a/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.test.ts +++ b/plugins/scaffolder-backend-module-gitlab/src/actions/gitlab.test.ts @@ -74,7 +74,7 @@ describe('publish:gitlab', () => { host: 'gitlab.com', token: 'tokenlols', apiBaseUrl: 'https://api.gitlab.com', - signingKey: 'test-signing-key', + commitSigningKey: 'test-signing-key', }, { host: 'hosted.gitlab.com', diff --git a/plugins/scaffolder-backend/config.d.ts b/plugins/scaffolder-backend/config.d.ts index 5fe7859f98..ae91c905b3 100644 --- a/plugins/scaffolder-backend/config.d.ts +++ b/plugins/scaffolder-backend/config.d.ts @@ -29,6 +29,7 @@ export interface Config { /** * Default PGP signing key for signing commits. + * @visibility secret */ defaultCommitSigningKey?: string; /**