scaffolder-backend: mark rules utilities as alpha

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
Vincenzo Scamporlino
2023-03-01 13:55:21 +01:00
parent 06f58a20f9
commit dcbd264860
4 changed files with 30 additions and 30 deletions
@@ -4,14 +4,43 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common';
import { Conditions } from '@backstage/plugin-permission-node';
import { PermissionCondition } from '@backstage/plugin-permission-common';
import { PermissionCriteria } from '@backstage/plugin-permission-common';
import { PermissionRule } from '@backstage/plugin-permission-node';
import { PermissionRuleParams } from '@backstage/plugin-permission-common';
import { ResourcePermission } from '@backstage/plugin-permission-common';
import { TaskBroker } from '@backstage/plugin-scaffolder-backend';
import { TemplateAction } from '@backstage/plugin-scaffolder-node';
import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateFilter } from '@backstage/plugin-scaffolder-backend';
import { TemplateGlobal } from '@backstage/plugin-scaffolder-backend';
import { TemplateParameter } from '@backstage/plugin-scaffolder-common';
// @alpha
export const catalogModuleTemplateKind: () => BackendFeature;
// @alpha
export const createScaffolderConditionalDecision: (
permission: ResourcePermission<'scaffolder-template'>,
conditions: PermissionCriteria<
PermissionCondition<'scaffolder-template', PermissionRuleParams>
>,
) => ConditionalPolicyDecision;
// @alpha
export const scaffolderConditions: Conditions<{
hasTag: PermissionRule<
TemplateParameter | TemplateEntityStepV1beta3,
{},
'scaffolder-template',
{
tag: string;
}
>;
}>;
// @alpha
export const scaffolderPlugin: (
options: ScaffolderPluginOptions,
-29
View File
@@ -9,8 +9,6 @@ import { ActionContext as ActionContext_2 } from '@backstage/plugin-scaffolder-n
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogProcessor } from '@backstage/plugin-catalog-node';
import { CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
import { ConditionalPolicyDecision } from '@backstage/plugin-permission-common';
import { Conditions } from '@backstage/plugin-permission-node';
import { Config } from '@backstage/config';
import { createPullRequest } from 'octokit-plugin-create-pull-request';
import { Duration } from 'luxon';
@@ -26,14 +24,9 @@ import { LocationSpec } from '@backstage/plugin-catalog-common';
import { Logger } from 'winston';
import { Observable } from '@backstage/types';
import { Octokit } from 'octokit';
import { PermissionCondition } from '@backstage/plugin-permission-common';
import { PermissionCriteria } from '@backstage/plugin-permission-common';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { PermissionRule } from '@backstage/plugin-permission-node';
import { PermissionRuleParams } from '@backstage/plugin-permission-common';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { ResourcePermission } from '@backstage/plugin-permission-common';
import { Schema } from 'jsonschema';
import { ScmIntegrationRegistry } from '@backstage/integration';
import { ScmIntegrations } from '@backstage/integration';
@@ -43,8 +36,6 @@ import { TaskSpec } from '@backstage/plugin-scaffolder-common';
import { TaskSpecV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateAction as TemplateAction_2 } from '@backstage/plugin-scaffolder-node';
import { TemplateActionOptions } from '@backstage/plugin-scaffolder-node';
import { TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
import { TemplateParameter } from '@backstage/plugin-scaffolder-common';
import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
import { ZodType } from 'zod';
@@ -528,14 +519,6 @@ export const createPublishGitlabMergeRequestAction: (options: {
// @public
export function createRouter(options: RouterOptions): Promise<express.Router>;
// @alpha
export const createScaffolderConditionalDecision: (
permission: ResourcePermission<'scaffolder-template'>,
conditions: PermissionCriteria<
PermissionCondition<'scaffolder-template', PermissionRuleParams>
>,
) => ConditionalPolicyDecision;
// @public @deprecated (undocumented)
export const createTemplateAction: <
TParams,
@@ -693,18 +676,6 @@ export type RunCommandOptions = {
logStream?: Writable;
};
// @alpha
export const scaffolderConditions: Conditions<{
hasTag: PermissionRule<
TemplateParameter | TemplateEntityStepV1beta3,
{},
'scaffolder-template',
{
tag: string;
}
>;
}>;
// @public (undocumented)
export class ScaffolderEntitiesProcessor implements CatalogProcessor {
// (undocumented)
+1
View File
@@ -15,5 +15,6 @@
*/
export * from './modules';
export * from './service/conditionExports';
export { scaffolderPlugin } from './ScaffolderPlugin';
export type { ScaffolderPluginOptions } from './ScaffolderPlugin';
-1
View File
@@ -21,7 +21,6 @@
*/
export * from './scaffolder';
export * from './service/conditionExports';
export * from './service/router';
export * from './lib';
export * from './processor';