diff --git a/API.md b/API.md index a4b70187..9c4f902f 100644 --- a/API.md +++ b/API.md @@ -1670,8 +1670,10 @@ const cdktfProviderProjectOptions: CdktfProviderProjectOptions = { ... } | constructsVersion | string | *No description.* | | terraformProvider | string | *No description.* | | creationYear | number | The year of the creation of the repository, for copyright purposes. | +| deprecationDate | string | An optional date when the project should be considered deprecated, to be used in the README text. | | forceMajorVersion | number | *No description.* | | githubNamespace | string | defaults to "cdktf" previously was "hashicorp". | +| isDeprecated | boolean | Whether or not this prebuilt provider is deprecated. | | mavenEndpoint | string | *No description.* | | mavenOrg | string | defaults to "hashicorp". | | namespace | string | defaults to "cdktf". | @@ -3936,6 +3938,21 @@ Will fall back to the current year if not specified. --- +##### `deprecationDate`Optional + +```typescript +public readonly deprecationDate: string; +``` + +- *Type:* string + +An optional date when the project should be considered deprecated, to be used in the README text. + +If no date is provided, then the +date of the build will be used by default. + +--- + ##### `forceMajorVersion`Optional ```typescript @@ -3960,6 +3977,20 @@ Used for GitHub org name and package scoping --- +##### `isDeprecated`Optional + +```typescript +public readonly isDeprecated: boolean; +``` + +- *Type:* boolean + +Whether or not this prebuilt provider is deprecated. + +If true, no new versions will be published. + +--- + ##### `mavenEndpoint`Optional ```typescript diff --git a/src/deprecate-packages.ts b/src/deprecate-packages.ts index 3441a71d..81f044d2 100644 --- a/src/deprecate-packages.ts +++ b/src/deprecate-packages.ts @@ -1,3 +1,8 @@ +/** + * Copyright (c) HashiCorp, Inc. + * SPDX-License-Identifier: MPL-2.0 + */ + import { JsiiProject } from "projen/lib/cdk"; import { JobPermission, JobStep } from "projen/lib/github/workflows-model"; import { PackageInfo } from "./package-info";