chore: updating the api report

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-02-21 15:57:18 +01:00
parent 9553964f28
commit 1a864a3b68
3 changed files with 11 additions and 10 deletions
+3 -1
View File
@@ -382,13 +382,15 @@ export function fetchContents({
// Warning: (ae-missing-release-tag) "OctokitProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
// @public @deprecated
export class OctokitProvider {
constructor(
integrations: ScmIntegrationRegistry,
githubCredentialsProvider?: GithubCredentialsProvider,
);
// Warning: (ae-forgotten-export) The symbol "OctokitIntegration" needs to be exported by the entry point index.d.ts
//
// @deprecated
getOctokit(
repoUrl: string,
options?: {
@@ -33,7 +33,8 @@ export type OctokitIntegration = {
* OctokitProvider provides Octokit client based on ScmIntegrationsRegistry configuration.
* OctokitProvider supports GitHub credentials caching out of the box.
*
* @deprecated use the internal {@link getOctokitOptions} function instead
* @deprecated we are no longer providing a way from the scaffolder to generate octokit instances.
* Implement your own if you're using this method from an external package, or suse the internal `getOctokitOptions` function instead
*/
export class OctokitProvider {
private readonly integrations: ScmIntegrationRegistry;
@@ -54,7 +55,8 @@ export class OctokitProvider {
*
* @param repoUrl - Repository URL
*
* @deprecated use the internal {@link getOctokitOptions} function instead
* @deprecated we are no longer providing a way from the scaffolder to generate octokit instances.
* Implement your own if you're using this method from an external package, or suse the internal `getOctokitOptions` function instead
*/
async getOctokit(
repoUrl: string,
@@ -19,7 +19,7 @@ import {
} from '@backstage/integration';
import { createTemplateAction } from '../../createTemplateAction';
import { emitterEventNames } from '@octokit/webhooks';
import { assertError } from '@backstage/errors';
import { assertError, InputError } from '@backstage/errors';
import { Octokit } from 'octokit';
import { getOctokitOptions } from './helpers';
import { parseRepoUrl } from '../publish/util';
@@ -29,11 +29,8 @@ export function createGithubWebhookAction(options: {
defaultWebhookSecret?: string;
githubCredentialsProvider?: GithubCredentialsProvider;
}) {
const {
integrations,
defaultWebhookSecret,
githubCredentialsProvider,
} = options;
const { integrations, defaultWebhookSecret, githubCredentialsProvider } =
options;
const eventNames = emitterEventNames.filter(event => !event.includes('.'));
@@ -139,7 +136,7 @@ export function createGithubWebhookAction(options: {
);
if (!owner) {
throw new InputError('Invalid repository owner');
throw new InputError('Invalid repository owner provided in repoUrl');
}
try {