Class TechdocsGenerator

constructor

• new TechdocsGenerator(
      options: {
          config: Config;
          containerRunner?: TechDocsContainerRunner;
          logger: LoggerService;
          scmIntegrations: ScmIntegrationRegistry;
      },
  ): TechdocsGenerator

  Parameters

  • options: {
        config: Config;
        containerRunner?: TechDocsContainerRunner;
        logger: LoggerService;
        scmIntegrations: ScmIntegrationRegistry;
    }

  Returns TechdocsGenerator

Static ReadonlydefaultDockerImage

run

• run(options: GeneratorRunOptions): Promise<void>

  Runs the generator with the values

  Parameters

  • options: GeneratorRunOptions

  Returns Promise<void>

StaticfromConfig

• fromConfig(config: Config, options: GeneratorOptions): TechdocsGenerator

  Returns a instance of TechDocs generator

  Parameters

  • config: Config

    A Backstage configuration

  • options: GeneratorOptions

    Options to configure the generator

  Returns TechdocsGenerator