paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/master' into feat/techdocs-build-logs

Browse Source 
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
This commit is contained in:
Dominik Henneke
2021-07-13 16:15:08 +02:00
parent fbba171405 7a6a3586ac
commit 246b1797e5
119 changed files with 9860 additions and 5109 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/techdocs-common/api-report.md
+157 -81
View File
@@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
/// <reference types="node" />
import { AzureIntegrationConfig } from '@backstage/integration';
import { Config } from '@backstage/config';
@@ -18,176 +19,251 @@ import { UrlReader } from '@backstage/backend-common';
import { Writable } from 'stream';
// @public (undocumented)
export const checkoutGitRepository: (repoUrl: string, config: Config, logger: Logger_2) => Promise<string>;
export const checkoutGitRepository: (
repoUrl: string,
config: Config,
logger: Logger_2,
) => Promise<string>;
// @public (undocumented)
export class CommonGitPreparer implements PreparerBase {
constructor(config: Config, logger: Logger_2);
// (undocumented)
prepare(entity: Entity, options?: {
etag?: string;
}): Promise<PreparerResponse>;
constructor(config: Config, logger: Logger_2);
// (undocumented)
prepare(
entity: Entity,
options?: {
etag?: string;
},
): Promise<PreparerResponse>;
}
// @public (undocumented)
export class DirectoryPreparer implements PreparerBase {
constructor(config: Config, logger: Logger_2, reader: UrlReader);
// (undocumented)
prepare(entity: Entity): Promise<PreparerResponse>;
}
constructor(config: Config, logger: Logger_2, reader: UrlReader);
// (undocumented)
prepare(entity: Entity): Promise<PreparerResponse>;
}
// @public (undocumented)
export type GeneratorBase = {
run(opts: GeneratorRunOptions): Promise<void>;
run(opts: GeneratorRunOptions): Promise<void>;
};
// @public
export type GeneratorBuilder = {
register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
get(entity: Entity): GeneratorBase;
register(protocol: SupportedGeneratorKey, generator: GeneratorBase): void;
get(entity: Entity): GeneratorBase;
};
// @public
export type GeneratorRunOptions = {
inputDir: string;
outputDir: string;
parsedLocationAnnotation?: ParsedLocationAnnotation;
etag?: string;
logger: Logger_2;
logStream?: Writable;
inputDir: string;
outputDir: string;
parsedLocationAnnotation?: ParsedLocationAnnotation;
etag?: string;
logger: Logger_2;
logStream?: Writable;
};
// @public (undocumented)
export class Generators implements GeneratorBuilder {
// (undocumented)
static fromConfig(config: Config, { logger, containerRunner, }: {
logger: Logger_2;
containerRunner: ContainerRunner;
}): Promise<GeneratorBuilder>;
// (undocumented)
get(entity: Entity): GeneratorBase;
// (undocumented)
register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase): void;
// (undocumented)
static fromConfig(
config: Config,
{
logger,
containerRunner,
}: {
logger: Logger_2;
containerRunner: ContainerRunner;
},
): Promise<GeneratorBuilder>;
// (undocumented)
get(entity: Entity): GeneratorBase;
// (undocumented)
register(generatorKey: SupportedGeneratorKey, generator: GeneratorBase): void;
}
// @public (undocumented)
export const getAzureIntegrationConfig: (config: Config, host: string) => AzureIntegrationConfig;
export const getAzureIntegrationConfig: (
config: Config,
host: string,
) => AzureIntegrationConfig;
// @public (undocumented)
export const getDefaultBranch: (repositoryUrl: string, config: Config) => Promise<string>;
export const getDefaultBranch: (
repositoryUrl: string,
config: Config,
) => Promise<string>;
// @public (undocumented)
export const getDocFilesFromRepository: (reader: UrlReader, entity: Entity, opts?: {
etag?: string | undefined;
logger?: Logger_2 | undefined;
} | undefined) => Promise<PreparerResponse>;
export const getDocFilesFromRepository: (
reader: UrlReader,
entity: Entity,
opts?:
| {
etag?: string | undefined;
logger?: Logger_2 | undefined;
}
| undefined,
) => Promise<PreparerResponse>;
// @public (undocumented)
export function getGitHost(url: string): string;
// @public (undocumented)
export const getGitHubIntegrationConfig: (config: Config, host: string) => GitHubIntegrationConfig;
export const getGitHubIntegrationConfig: (
config: Config,
host: string,
) => GitHubIntegrationConfig;
// @public (undocumented)
export const getGitLabIntegrationConfig: (config: Config, host: string) => GitLabIntegrationConfig;
export const getGitLabIntegrationConfig: (
config: Config,
host: string,
) => GitLabIntegrationConfig;
// @public (undocumented)
export const getGitRepositoryTempFolder: (repositoryUrl: string, config: Config) => Promise<string>;
export const getGitRepositoryTempFolder: (
repositoryUrl: string,
config: Config,
) => Promise<string>;
// @public (undocumented)
export function getGitRepoType(url: string): string;
// @public (undocumented)
export const getLastCommitTimestamp: (repositoryLocation: string, logger: Logger_2) => Promise<number>;
export const getLastCommitTimestamp: (
repositoryLocation: string,
logger: Logger_2,
) => Promise<number>;
// @public (undocumented)
export const getLocationForEntity: (entity: Entity) => ParsedLocationAnnotation;
// @public (undocumented)
export const getTokenForGitRepo: (repositoryUrl: string, config: Config) => Promise<string | undefined>;
export const getTokenForGitRepo: (
repositoryUrl: string,
config: Config,
) => Promise<string | undefined>;
// @public (undocumented)
export type ParsedLocationAnnotation = {
type: RemoteProtocol;
target: string;
type: RemoteProtocol;
target: string;
};
// @public (undocumented)
export const parseReferenceAnnotation: (annotationName: string, entity: Entity) => ParsedLocationAnnotation;
export const parseReferenceAnnotation: (
annotationName: string,
entity: Entity,
) => ParsedLocationAnnotation;
// @public (undocumented)
export type PreparerBase = {
prepare(entity: Entity, options?: {
logger?: Logger_2;
etag?: string;
}): Promise<PreparerResponse>;
prepare(
entity: Entity,
options?: {
logger?: Logger_2;
etag?: string;
},
): Promise<PreparerResponse>;
};
// @public (undocumented)
export type PreparerBuilder = {
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
get(entity: Entity): PreparerBase;
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
get(entity: Entity): PreparerBase;
};
// @public (undocumented)
export class Preparers implements PreparerBuilder {
// (undocumented)
static fromConfig(config: Config, { logger, reader }: factoryOptions): Promise<PreparerBuilder>;
// (undocumented)
get(entity: Entity): PreparerBase;
// (undocumented)
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
// (undocumented)
static fromConfig(
config: Config,
{ logger, reader }: factoryOptions,
): Promise<PreparerBuilder>;
// (undocumented)
get(entity: Entity): PreparerBase;
// (undocumented)
register(protocol: RemoteProtocol, preparer: PreparerBase): void;
}
// @public
export class Publisher {
// (undocumented)
static fromConfig(config: Config, { logger, discovery }: factoryOptions_2): Promise<PublisherBase>;
// (undocumented)
static fromConfig(
config: Config,
{ logger, discovery }: factoryOptions_2,
): Promise<PublisherBase>;
}
// @public
export interface PublisherBase {
docsRouter(): express.Handler;
fetchTechDocsMetadata(entityName: EntityName): Promise<TechDocsMetadata>;
getReadiness(): Promise<ReadinessResponse>;
hasDocsBeenGenerated(entityName: Entity): Promise<boolean>;
publish(request: PublishRequest): Promise<PublishResponse>;
docsRouter(): express.Handler;
fetchTechDocsMetadata(entityName: EntityName): Promise<TechDocsMetadata>;
getReadiness(): Promise<ReadinessResponse>;
hasDocsBeenGenerated(entityName: Entity): Promise<boolean>;
publish(request: PublishRequest): Promise<PublishResponse>;
}
// @public
export type PublisherType = 'local' | 'googleGcs' | 'awsS3' | 'azureBlobStorage' | 'openStackSwift';
export type PublisherType =
| 'local'
| 'googleGcs'
| 'awsS3'
| 'azureBlobStorage'
| 'openStackSwift';
// @public
export type RemoteProtocol = 'url' | 'dir' | 'github' | 'gitlab' | 'file' | 'azure/api';
export type RemoteProtocol =
| 'url'
| 'dir'
| 'github'
| 'gitlab'
| 'file'
| 'azure/api';
// @public (undocumented)
export class TechdocsGenerator implements GeneratorBase {
constructor({ logger, containerRunner, config, }: {
logger: Logger_2;
containerRunner: ContainerRunner;
config: Config;
});
// (undocumented)
run({ inputDir, outputDir, parsedLocationAnnotation, etag, logger: childLogger, logStream, }: GeneratorRunOptions): Promise<void>;
constructor({
logger,
containerRunner,
config,
}: {
logger: Logger_2;
containerRunner: ContainerRunner;
config: Config;
});
// (undocumented)
run({
inputDir,
outputDir,
parsedLocationAnnotation,
etag,
logger: childLogger,
logStream,
}: GeneratorRunOptions): Promise<void>;
}
// @public
export type TechDocsMetadata = {
site_name: string;
site_description: string;
etag: string;
site_name: string;
site_description: string;
etag: string;
};
// @public (undocumented)
export class UrlPreparer implements PreparerBase {
constructor(reader: UrlReader, logger: Logger_2);
// (undocumented)
prepare(entity: Entity, options?: {
etag?: string;
}): Promise<PreparerResponse>;
}
constructor(reader: UrlReader, logger: Logger_2);
// (undocumented)
prepare(
entity: Entity,
options?: {
etag?: string;
},
): Promise<PreparerResponse>;
}
// (No @packageDocumentation comment for this package)
```
packages/techdocs-common/package.json
+1 -1
View File
@@ -48,7 +48,7 @@
"aws-sdk": "^2.840.0",
"cross-fetch": "^3.0.6",
"express": "^4.17.1",
"fs-extra": "^10.0.0",
"fs-extra": "9.1.0",
"git-url-parse": "~11.4.4",
"js-yaml": "^4.0.0",
"json5": "^2.1.3",