refactor(techdocs): deprecate ShouldBuildParameters type

Signed-off-by: Phil Kuang <pkuang@factset.com>
This commit is contained in:
Phil Kuang
2023-10-24 13:06:05 -04:00
parent 31458f5b63
commit b99e29ab8f
6 changed files with 15 additions and 27 deletions
+5 -3
View File
@@ -20,9 +20,9 @@
* @packageDocumentation
*/
import { Entity } from '@backstage/catalog-model';
import {
DocsBuildStrategy as _DocsBuildStrategy,
ShouldBuildParameters as _ShouldBuildParameters,
TechDocsDocument as _TechDocsDocument,
} from '@backstage/plugin-techdocs-node';
@@ -49,9 +49,11 @@ export type {
export type DocsBuildStrategy = _DocsBuildStrategy;
/**
* @public
* @deprecated import from `@backstage/plugin-techdocs-node` instead
* @deprecated use direct type definition instead
*/
export type ShouldBuildParameters = _ShouldBuildParameters;
export type ShouldBuildParameters = {
entity: Entity;
};
/**
* @public
* @deprecated import from `@backstage/plugin-techdocs-node` instead
@@ -13,11 +13,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Entity } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
import {
DocsBuildStrategy,
ShouldBuildParameters,
} from '@backstage/plugin-techdocs-node';
import { DocsBuildStrategy } from '@backstage/plugin-techdocs-node';
export class DefaultDocsBuildStrategy implements DocsBuildStrategy {
private readonly config: Config;
@@ -30,7 +28,7 @@ export class DefaultDocsBuildStrategy implements DocsBuildStrategy {
return new DefaultDocsBuildStrategy(config);
}
async shouldBuild(_: ShouldBuildParameters): Promise<boolean> {
async shouldBuild(_: { entity: Entity }): Promise<boolean> {
return this.config.getString('techdocs.builder') === 'local';
}
}