techdocs: add common package for annotation constants

Signed-off-by: MT Lewis <mtlewis@users.noreply.github.com>

.changeset/quick-roses-juggle.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-techdocs-common': minor
+---
+
+Initial release of the techdocs-common package.

plugins/techdocs-backend/package.json

@@ -8,6 +8,7 @@
     "pluginPackages": [
       "@backstage/plugin-techdocs",
       "@backstage/plugin-techdocs-backend",
+      "@backstage/plugin-techdocs-common",
       "@backstage/plugin-techdocs-node",
       "@backstage/plugin-techdocs-react"
     ]

plugins/techdocs-common/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

plugins/techdocs-common/README.md

@@ -0,0 +1,3 @@
+# @backstage/plugin-techdocs-common
+
+Common functionality for TechDocs

plugins/techdocs-common/api-report.md

@@ -0,0 +1,11 @@
+## API Report File for "@backstage/plugin-techdocs-common"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+// @public (undocumented)
+export const TECHDOCS_ANNOTATION = 'backstage.io/techdocs-ref';
+
+// @public (undocumented)
+export const TECHDOCS_EXTERNAL_ANNOTATION = 'backstage.io/techdocs-entity';
+```

plugins/techdocs-common/catalog-info.yaml

@@ -0,0 +1,11 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: backstage-plugin-techdocs-common
+  title: '@backstage/plugin-techdocs-common'
+  description: >-
+    Common functionality for TechDocs
+spec:
+  lifecycle: production
+  type: backstage-common-library
+  owner: techdocs-maintainers

plugins/techdocs-common/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@backstage/plugin-techdocs-common",
+  "version": "0.0.0",
+  "description": "Common functionality for TechDocs",
+  "backstage": {
+    "role": "common-library",
+    "pluginId": "techdocs",
+    "pluginPackages": [
+      "@backstage/plugin-techdocs",
+      "@backstage/plugin-techdocs-backend",
+      "@backstage/plugin-techdocs-common",
+      "@backstage/plugin-techdocs-node",
+      "@backstage/plugin-techdocs-react"
+    ]
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "keywords": [
+    "backstage",
+    "techdocs"
+  ],
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/techdocs-common"
+  },
+  "bugs": {
+    "url": "https://github.com/backstage/backstage/issues"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "test": "backstage-cli package test"
+  },
+  "devDependencies": {
+    "@backstage/cli": "workspace:^"
+  }
+}

plugins/techdocs-common/src/constants.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** @public */
+export const TECHDOCS_ANNOTATION = 'backstage.io/techdocs-ref';
+/** @public */
+export const TECHDOCS_EXTERNAL_ANNOTATION = 'backstage.io/techdocs-entity';

plugins/techdocs-common/src/index.test.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as anything from './';
+
+describe('techdocs-common', () => {
+  // TODO: Test real things once they exist.
+  it('should exist', () => {
+    expect(anything).toBeTruthy();
+  });
+});

plugins/techdocs-common/src/index.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Common functionality for TechDocs
+ *
+ * @packageDocumentation
+ */
+export * from './constants';

plugins/techdocs-node/package.json

@@ -8,6 +8,7 @@
     "pluginPackages": [
       "@backstage/plugin-techdocs",
       "@backstage/plugin-techdocs-backend",
+      "@backstage/plugin-techdocs-common",
       "@backstage/plugin-techdocs-node",
       "@backstage/plugin-techdocs-react"
     ]

plugins/techdocs-react/package.json

@@ -8,6 +8,7 @@
     "pluginPackages": [
       "@backstage/plugin-techdocs",
       "@backstage/plugin-techdocs-backend",
+      "@backstage/plugin-techdocs-common",
       "@backstage/plugin-techdocs-node",
       "@backstage/plugin-techdocs-react"
     ]

plugins/techdocs/package.json

@@ -8,6 +8,7 @@
     "pluginPackages": [
       "@backstage/plugin-techdocs",
       "@backstage/plugin-techdocs-backend",
+      "@backstage/plugin-techdocs-common",
       "@backstage/plugin-techdocs-node",
       "@backstage/plugin-techdocs-react"
     ]