From da78e79a948b99a40802b6b3ec0194d7350f7e73 Mon Sep 17 00:00:00 2001
From: Karan Shah <karan.shah@simplybusiness.co.uk>
Date: Thu, 17 Feb 2022 10:29:56 +0000
Subject: [PATCH] Get the plugins ready for release

Signed-off-by: Karan Shah <karan.shah@simplybusiness.co.uk>
---
 .changeset/heavy-scissors-run.md       |  6 ++++++
 plugins/airbrake-backend/api-report.md |  6 +++++-
 plugins/airbrake/api-report.md         | 10 ++--------
 plugins/airbrake/src/extensions.tsx    |  5 +++++
 plugins/airbrake/src/index.ts          |  7 +++++++
 plugins/airbrake/src/plugin.ts         |  5 +++++
 6 files changed, 30 insertions(+), 9 deletions(-)
 create mode 100644 .changeset/heavy-scissors-run.md

diff --git a/.changeset/heavy-scissors-run.md b/.changeset/heavy-scissors-run.md
new file mode 100644
index 0000000000..c2982a509c
--- /dev/null
+++ b/.changeset/heavy-scissors-run.md
@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-airbrake': minor
+'@backstage/plugin-airbrake-backend': minor
+---
+
+This marks the first release where the Airbrake plugin is useable. Airbrake frontend and Airbrake backend work with each other. Currently just a summary of the latest Airbrakes is shown on Backstage.
diff --git a/plugins/airbrake-backend/api-report.md b/plugins/airbrake-backend/api-report.md
index b9e9a50e0b..58f299fb4c 100644
--- a/plugins/airbrake-backend/api-report.md
+++ b/plugins/airbrake-backend/api-report.md
@@ -6,6 +6,7 @@
 import { Config } from '@backstage/config';
 import express from 'express';
 import { Logger as Logger_2 } from 'winston';
+import * as winston from 'winston';
 
 // @public
 export interface AirbrakeConfig {
@@ -16,7 +17,10 @@ export interface AirbrakeConfig {
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
 // @public
-export function extractAirbrakeConfig(config: Config): AirbrakeConfig;
+export function extractAirbrakeConfig(
+  config: Config,
+  logger: winston.Logger,
+): AirbrakeConfig;
 
 // @public
 export interface RouterOptions {
diff --git a/plugins/airbrake/api-report.md b/plugins/airbrake/api-report.md
index c01aa938ae..bd274e604d 100644
--- a/plugins/airbrake/api-report.md
+++ b/plugins/airbrake/api-report.md
@@ -8,9 +8,7 @@
 import { BackstagePlugin } from '@backstage/core-plugin-api';
 import { RouteRef } from '@backstage/core-plugin-api';
 
-// Warning: (ae-missing-release-tag) "airbrakePlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const airbrakePlugin: BackstagePlugin<
   {
     root: RouteRef<undefined>;
@@ -18,10 +16,6 @@ export const airbrakePlugin: BackstagePlugin<
   {}
 >;
 
-// Warning: (ae-missing-release-tag) "EntityAirbrakeContent" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const EntityAirbrakeContent: () => JSX.Element;
-
-// (No @packageDocumentation comment for this package)
 ```
diff --git a/plugins/airbrake/src/extensions.tsx b/plugins/airbrake/src/extensions.tsx
index 6fbea68409..d4f890f44a 100644
--- a/plugins/airbrake/src/extensions.tsx
+++ b/plugins/airbrake/src/extensions.tsx
@@ -20,6 +20,11 @@ import { airbrakePlugin } from './plugin';
 import { createRoutableExtension } from '@backstage/core-plugin-api';
 import { rootRouteRef } from './routes';
 
+/**
+ * This is the widget that shows up on a component page
+ *
+ * @public
+ */
 export const EntityAirbrakeContent = airbrakePlugin.provide(
   createRoutableExtension({
     name: 'EntityAirbrakeContent',
diff --git a/plugins/airbrake/src/index.ts b/plugins/airbrake/src/index.ts
index d5aedd9ba6..2b2406776b 100644
--- a/plugins/airbrake/src/index.ts
+++ b/plugins/airbrake/src/index.ts
@@ -13,5 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/**
+ * The Airbrake plugin provides connectivity between Backstage and Airbrake (https://airbrake.io/).
+ *
+ * @packageDocumentation
+ */
+
 export { airbrakePlugin } from './plugin';
 export { EntityAirbrakeContent } from './extensions';
diff --git a/plugins/airbrake/src/plugin.ts b/plugins/airbrake/src/plugin.ts
index e7e3dae1cb..56f65ba110 100644
--- a/plugins/airbrake/src/plugin.ts
+++ b/plugins/airbrake/src/plugin.ts
@@ -22,6 +22,11 @@ import {
 import { rootRouteRef } from './routes';
 import { airbrakeApiRef, ProductionAirbrakeApi } from './api';
 
+/**
+ * The Airbrake plugin instance
+ *
+ * @public
+ */
 export const airbrakePlugin = createPlugin({
   id: 'airbrake',
   apis: [