jenkins-backend

Signed-off-by: Fredrik Adelöw <freben@gmail.com>

plugins/jenkins-backend/api-report.md

@@ -11,13 +11,9 @@ import { Logger } from 'winston';
 import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
 import { PermissionEvaluator } from '@backstage/plugin-permission-common';
 
-// Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
-// Warning: (ae-missing-release-tag) "DefaultJenkinsInfoProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public
 export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
   // (undocumented)
@@ -37,8 +33,6 @@ export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
   static readonly OLD_JENKINS_ANNOTATION = 'jenkins.io/github-folder';
 }
 
-// Warning: (ae-missing-release-tag) "JenkinsConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public
 export class JenkinsConfig {
   constructor(instances: JenkinsInstanceConfig[]);
@@ -48,8 +42,6 @@ export class JenkinsConfig {
   readonly instances: JenkinsInstanceConfig[];
 }
 
-// Warning: (ae-missing-release-tag) "JenkinsInfo" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export interface JenkinsInfo {
   // (undocumented)
@@ -62,8 +54,6 @@ export interface JenkinsInfo {
   jobFullName: string;
 }
 
-// Warning: (ae-missing-release-tag) "JenkinsInfoProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export interface JenkinsInfoProvider {
   // (undocumented)
@@ -74,8 +64,6 @@ export interface JenkinsInfoProvider {
   }): Promise<JenkinsInfo>;
 }
 
-// Warning: (ae-missing-release-tag) "JenkinsInstanceConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export interface JenkinsInstanceConfig {
   // (undocumented)
@@ -90,8 +78,6 @@ export interface JenkinsInstanceConfig {
   username: string;
 }
 
-// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public (undocumented)
 export interface RouterOptions {
   // (undocumented)

plugins/jenkins-backend/src/service/jenkinsInfoProvider.ts

@@ -22,6 +22,7 @@ import {
 } from '@backstage/catalog-model';
 import { Config } from '@backstage/config';
 
+/** @public */
 export interface JenkinsInfoProvider {
   getInstance(options: {
     /**
@@ -37,6 +38,7 @@ export interface JenkinsInfoProvider {
   }): Promise<JenkinsInfo>;
 }
 
+/** @public */
 export interface JenkinsInfo {
   baseUrl: string;
   headers?: Record<string, string | string[]>;
@@ -44,6 +46,7 @@ export interface JenkinsInfo {
   crumbIssuer?: boolean;
 }
 
+/** @public */
 export interface JenkinsInstanceConfig {
   name: string;
   baseUrl: string;
@@ -54,6 +57,8 @@ export interface JenkinsInstanceConfig {
 
 /**
  * Holds multiple Jenkins configurations.
+ *
+ * @public
  */
 export class JenkinsConfig {
   constructor(public readonly instances: JenkinsInstanceConfig[]) {}
@@ -163,6 +168,8 @@ export class JenkinsConfig {
  * Use default config and annotations, build using fromConfig static function.
  *
  * This will fallback through various deprecated config and annotation schemes.
+ *
+ * @public
  */
 export class DefaultJenkinsInfoProvider implements JenkinsInfoProvider {
   static readonly OLD_JENKINS_ANNOTATION = 'jenkins.io/github-folder';

plugins/jenkins-backend/src/service/router.ts

@@ -28,12 +28,14 @@ import {
 import { getBearerTokenFromAuthorizationHeader } from '@backstage/plugin-auth-node';
 import { stringifyEntityRef } from '@backstage/catalog-model';
 
+/** @public */
 export interface RouterOptions {
   logger: Logger;
   jenkinsInfoProvider: JenkinsInfoProvider;
   permissions?: PermissionEvaluator | PermissionAuthorizer;
 }
 
+/** @public */
 export async function createRouter(
   options: RouterOptions,
 ): Promise<express.Router> {

scripts/api-extractor.ts

@@ -207,7 +207,6 @@ const ALLOW_WARNINGS = [
   'plugins/github-deployments',
   'plugins/github-pull-requests-board',
   'plugins/jenkins',
-  'plugins/jenkins-backend',
   'plugins/kubernetes',
   'plugins/kubernetes-common',
 ];