Merge pull request #15790 from backstage/blam/fix-changesets

chore: fix some changeset

.changeset/angry-cheetahs-hide.md

@@ -1,5 +1,5 @@
 ---
-'@backstage/plugin-scaffolder-backend': patch
+'@backstage/plugin-scaffolder-backend': minor
 ---
 
-Implement "Required approving review count", "Restrictions", and "Required commit signing" support for "publish:github" action
+Implement `Required approving review count`, `Restrictions`, and `Required commit signing` support for `publish:github` action

.changeset/dull-cabs-carry.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-adr-backend': patch
+---
+
+This plugin now exports a `createRouter` method which uses `UrlReaders` to make requests to your SCM. Please make sure you read the [install instructions](https://github.com/backstage/backstage/blob/master/plugins/adr-backend/README.md#install)

.changeset/dull-taxis-carry.md

@@ -1,8 +1,7 @@
 ---
 '@backstage/plugin-adr': minor
-'@backstage/plugin-adr-backend': patch
 ---
 
 The ADR plugin can now work with sites other than GitHub. Expanded the ADR backend plugin to provide endpoints to facilitate this.
 
-**BREAKING** The ADR plugin now uses UrlReaders. You will have to [configure integrations](https://backstage.io/docs/integrations/index#configuration) for all sites you want to get ADRs from. If you would like to create your own implementation that has different behavior, you can override the AdrApi [just like you can with other apis.](https://backstage.io/docs/api/utility-apis#app-apis) The previously used Octokit implementation has been completely removed.
+**BREAKING** The ADR plugin now requires the `@backstage/plugin-adr-backend` plugin to be installed by using the `createRouter` method to add into your `backend`. You read more in the [install instructions](https://github.com/backstage/backstage/blob/master/plugins/adr-backend/README.md#install)

.changeset/metal-nails-punch.md

@@ -1,8 +1,8 @@
 ---
-'@backstage/plugin-scaffolder-backend': patch
+'@backstage/plugin-scaffolder-backend': minor
 ---
 
-This patch adds changes to provide examples alongside scaffolder task actions.
+This change adds changes to provide examples alongside scaffolder task actions.
 
 The `createTemplateAction` function now takes a list of examples e.g.
 

plugins/adr-backend/README.md

@@ -6,6 +6,59 @@ This ADR backend plugin is primarily responsible for the following:
 
 - Provides endpoints that use UrlReaders for getting ADR documents (used in the [ADR frontend plugin](../adr/README.md)).
 
+## Install
+
+## Setup your `integrations` config
+
+First off you'll need to setup your `integrations` config inside your `app-config.yaml`. You can skip this step if it's already setup previously, and if you need help configuring this you can read the [integrations documentation](https://backstage.io/docs/integrations/)
+
+### Up and Running
+
+Here's how to get the backend up and running:
+
+1. First we need to add the `@backstage/plugin-adr-backend` package to your backend:
+
+```sh
+# From the Backstage root directory
+cd packages/backend
+yarn add @backstage/plugin-adr-backend
+```
+
+2. Then we will create a new file named `packages/backend/src/plugins/adr.ts`, and add the
+   following to it:
+
+```ts
+import { createRouter } from '@backstage/plugin-adr-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  return await createRouter({
+    reader: env.reader,
+    cacheClient: env.cache.getClient(),
+    logger: env.logger,
+  });
+}
+```
+
+3. Next we wire this into the overall backend router, edit `packages/backend/src/index.ts`:
+
+```ts
+import adr from './plugins/adr';
+// ...
+async function main() {
+  // ...
+  // Add this line under the other lines that follow the useHotMemoize pattern
+  const adrEnv = useHotMemoize(module, () => createEnv('adr'));
+  // ...
+  // Insert this line under the other lines that add their routers to apiRouter in the same way
+  apiRouter.use('/adr', await adr(adrEnv));
+```
+
+4. Now run `yarn start-backend` from the repo root
+
 ## Indexing ADR documents for search
 
 Before you are able to start indexing ADR documents to search, you need to go through the [search getting started guide](https://backstage.io/docs/features/search/getting-started).