docs: add history details (#2022)

microsoft · May 7, 2024 · 99b6feb · 99b6feb
1 parent 38402c3
commit 99b6feb
Show file tree

Hide file tree

Showing 25 changed files with 199 additions and 50 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -332,6 +332,20 @@ gate them behind a version check. For example, we only use
 `androidx.core:core-ktx:1.10.1` when on Kotlin 1.8 or higher. See
 [`dependencies.gradle`][] for other examples.
 
+## Documentation
+
+The schema for `app.json` is documented here:
+https://github.com/microsoft/react-native-test-app/wiki/Manifest-(app.json)
+
+This page is wholly generated with the command, `npm run generate:docs`. You can
+copy the output and replace the page content in its entirety.
+
+Documentation is generated by [`generate-schema.mjs`][] and sources Markdown
+files under [`scripts/docs/`][].
+
+When making changes to docs, also ensure that `schema.json` gets updated by
+running `npm run generate:schema`.
+
 <!-- References -->
 
 [Dependency Dashboard]:
@@ -344,10 +358,14 @@ gate them behind a version check. For example, we only use
   https://github.com/microsoft/rnx-kit/tree/main/packages/react-native-host#readme
 [`dependencies.gradle`]:
   https://github.com/microsoft/react-native-test-app/blob/trunk/android/dependencies.gradle
+[`generate-schema.mjs`]:
+  https://github.com/microsoft/react-native-test-app/blob/trunk/scripts/generate-schema.mjs
 [`package.json`]:
   https://github.com/microsoft/react-native-test-app/blob/trunk/package.json
 [`react-native-releases`]:
   https://github.com/reactwg/react-native-releases/discussions
+[`scripts/docs/`]:
+  https://github.com/microsoft/react-native-test-app/tree/trunk/scripts/docs
 [`test:matrix`]:
   https://github.com/microsoft/react-native-test-app/blob/trunk/scripts/test-matrix.mjs
 [`uuid`]: https://github.com/uuidjs/uuid

diff --git a/schema.json b/schema.json
diff --git a/scripts/docs/android.icons.md b/scripts/docs/android.icons.md
@@ -8,5 +8,10 @@ to generate the assets.
 You can read more about Android adaptive icons in the
 [Android documentation](https://developer.android.com/guide/practices/ui_guidelines/icon_design_adaptive).
 
-Introduced in
-[1.6.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.6.0).
+<details>
+<summary>History</summary>
+
+- [[1.6.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.6.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/android.package.md b/scripts/docs/android.package.md
@@ -0,0 +1,11 @@
+Use this property to set the
+<a href='https://developer.android.com/studio/build/application-id'>application
+ID</a> of the APK. The value is set to `applicationId` in `build.gradle`.
+
+<details>
+<summary>History</summary>
+
+- [[0.1.25](https://github.com/microsoft/react-native-test-app/releases/tag/0.1.25)]
+  Added
+
+</details>
diff --git a/scripts/docs/android.signingConfigs.md b/scripts/docs/android.signingConfigs.md
@@ -26,5 +26,10 @@ for the debug and release flavors:
 }
 ```
 
-Introduced in
-[0.11.0](https://github.com/microsoft/react-native-test-app/releases/tag/0.11.0).
+<details>
+<summary>History</summary>
+
+- [[0.11.0](https://github.com/microsoft/react-native-test-app/releases/tag/0.11.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/android.versionCode.md b/scripts/docs/android.versionCode.md
@@ -3,5 +3,10 @@ to determine whether one version is more recent than another. See
 [Version your app](https://developer.android.com/studio/publish/versioning#appversioning)
 for more on how it is used and how it differs from [`version`](#version).
 
-Introduced in
-[1.4.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.4.0).
+<details>
+<summary>History</summary>
+
+- [[1.4.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.4.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/bundleRoot.md b/scripts/docs/bundleRoot.md
@@ -12,5 +12,10 @@ When set, the test app will look for the following files on startup:
 - `myRoot.jsbundle`
 - `myRoot.bundle`
 
-Introduced in
-[0.9.0](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.0).
+<details>
+<summary>History</summary>
+
+- [[0.9.0](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.buildNumber.md b/scripts/docs/ios.buildNumber.md
@@ -4,5 +4,10 @@ key for App Store.
 The equivalent key in `Info.plist` is
 [`CFBundleVersion`](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleversion).
 
-Introduced in
-[1.4.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.4.0).
+<details>
+<summary>History</summary>
+
+- [[1.4.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.4.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.bundleIdentifier.md b/scripts/docs/ios.bundleIdentifier.md
@@ -0,0 +1,10 @@
+Use this property to set the bundle identifier of the final app bundle. This is
+the same as setting `PRODUCT_BUNDLE_IDENTIFIER` in Xcode.
+
+<details>
+<summary>History</summary>
+
+- [[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.codeSignEntitlements.md b/scripts/docs/ios.codeSignEntitlements.md
@@ -18,3 +18,13 @@ For more details, read Apple's documentation on
 Alternatively, specify a path to a custom `.entitlements` file. The path should
 be relative to `app.json`. This is equivalent to setting
 `CODE_SIGN_ENTITLEMENTS` in Xcode.
+
+<details>
+<summary>History</summary>
+
+- [[3.7.0](https://github.com/microsoft/react-native-test-app/releases/tag/3.7.0)]
+  Declare entitlements in app manifest
+- [[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.codeSignIdentity.md b/scripts/docs/ios.codeSignIdentity.md
@@ -4,5 +4,10 @@ signing identity</a> to use when signing code.
 
 This is the same as setting `CODE_SIGN_IDENTITY` in Xcode.
 
-Introduced in
-[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7).
+<details>
+<summary>History</summary>
+
+- [[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.developmentTeam.md b/scripts/docs/ios.developmentTeam.md
@@ -4,5 +4,10 @@ team</a> that the app should be assigned to.
 
 This is the same as setting `DEVELOPMENT_TEAM` in Xcode.
 
-Introduced in
-[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7).
+<details>
+<summary>History</summary>
+
+- [[0.9.7](https://github.com/microsoft/react-native-test-app/releases/tag/0.9.7)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.icons.md b/scripts/docs/ios.icons.md
@@ -9,5 +9,10 @@ You can read more about app icons in the
 The equivalent key in `Info.plist` is
 [`CFBundleIcons`](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleicons).
 
-Introduced in
-[1.6.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.6.0).
+<details>
+<summary>History</summary>
+
+- [[1.6.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.6.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/ios.privacyManifest.md b/scripts/docs/ios.privacyManifest.md
@@ -39,3 +39,11 @@ values:
 
 For more details, read Apple's documentation on
 [Privacy manifest files](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files).
+
+<details>
+<summary>History</summary>
+
+- [[3.6.0](https://github.com/microsoft/react-native-test-app/releases/tag/3.6.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/macos.applicationCategoryType.md b/scripts/docs/macos.applicationCategoryType.md
@@ -2,3 +2,11 @@ The category that best describes the app for the App Store.
 
 The equivalent key in `Info.plist` is
 [`LSApplicationCategoryType`](https://developer.apple.com/documentation/bundleresources/information_property_list/lsapplicationcategorytype).
+
+<details>
+<summary>History</summary>
+
+- [[3.5.13](https://github.com/microsoft/react-native-test-app/releases/tag/3.5.13)]
+  Added
+
+</details>
diff --git a/scripts/docs/macos.humanReadableCopyright.md b/scripts/docs/macos.humanReadableCopyright.md
@@ -2,3 +2,11 @@ A human-readable copyright notice for the bundle.
 
 The equivalent key in `Info.plist` is
 [`NSHumanReadableCopyright`](https://developer.apple.com/documentation/bundleresources/information_property_list/nshumanreadablecopyright).
+
+<details>
+<summary>History</summary>
+
+- [[3.5.13](https://github.com/microsoft/react-native-test-app/releases/tag/3.5.13)]
+  Added
+
+</details>
diff --git a/scripts/docs/singleApp.md b/scripts/docs/singleApp.md
@@ -5,5 +5,10 @@ Defaults to multi-app mode.
 
 For more details, see [its dedicated page](Single-app-Mode).
 
-Introduced in
-[1.3.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.3.0).
+<details>
+<summary>History</summary>
+
+- [[1.3.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.3.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/version.md b/scripts/docs/version.md
@@ -14,5 +14,10 @@ integers, such as 1.3.11.
   [app package manifest](https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/appx-package-manifest)
   instead.
 
-Introduced in
-[1.4.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.4.0).
+<details>
+<summary>History</summary>
+
+- [[1.4.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.4.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/windows.appxManifest.md b/scripts/docs/windows.appxManifest.md
@@ -4,5 +4,10 @@ package manifest</a>. If none is set, a default manifest will be provided.
 Changes to this property will not be automatically be picked up; you need to
 re-run `npx install-windows-test-app` to update the solution.
 
-Introduced in
-[0.5.5](https://github.com/microsoft/react-native-test-app/releases/tag/0.5.5).
+<details>
+<summary>History</summary>
+
+- [[0.5.5](https://github.com/microsoft/react-native-test-app/releases/tag/0.5.5)]
+  Added
+
+</details>
diff --git a/scripts/docs/windows.certificateKeyFile.md b/scripts/docs/windows.certificateKeyFile.md
@@ -2,5 +2,10 @@ The path to the certificate to use. If specified, it will also enable package
 signing. Changes to this property will not be automatically be picked up; you
 need to re-run `npx install-windows-test-app` to update the solution.
 
-Introduced in
-[1.1.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.1.0).
+<details>
+<summary>History</summary>
+
+- [1.1.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.1.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/windows.certificatePassword.md b/scripts/docs/windows.certificatePassword.md
@@ -2,5 +2,10 @@ The password for the private key in the certificate. Leave unset if no password.
 Changes to this property will not be automatically be picked up; you need to
 re-run `npx install-windows-test-app` to update the solution.
 
-Introduced in
-[1.1.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.1.0).
+<details>
+<summary>History</summary>
+
+- [1.1.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.1.0)]
+  Added
+
+</details>
diff --git a/scripts/docs/windows.certificateThumbprint.md b/scripts/docs/windows.certificateThumbprint.md
@@ -2,5 +2,10 @@ This value must match the thumbprint in the signing certificate, or be unset.
 Changes to this property will not be automatically be picked up; you need to
 re-run `npx install-windows-test-app` to update the solution.
 
-Introduced in
-[1.1.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.1.0).
+<details>
+<summary>History</summary>
+
+- [1.1.0](https://github.com/microsoft/react-native-test-app/releases/tag/1.1.0)]
+  Added
+
+</details>
diff --git a/scripts/generate-schema.mjs b/scripts/generate-schema.mjs
@@ -29,9 +29,11 @@ export async function readDocumentation() {
     "singleApp",
     "version",
     "android.icons",
+    "android.package",
     "android.signingConfigs",
     "android.versionCode",
     "ios.buildNumber",
+    "ios.bundleIdentifier",
     "ios.codeSignEntitlements",
     "ios.codeSignIdentity",
     "ios.developmentTeam",

diff --git a/scripts/schema.mjs b/scripts/schema.mjs
@@ -47,8 +47,8 @@ export function generateSchema(docs = {}) {
         type: "object",
         properties: {
           bundleIdentifier: {
-            description:
-              "Use this property to set the bundle identifier of the final app bundle. This is the same as setting `PRODUCT_BUNDLE_IDENTIFIER` in Xcode.",
+            description: extractBrief(docs["ios.bundleIdentifier"]),
+            markdownDescription: docs["ios.bundleIdentifier"],
             type: "string",
           },
           buildNumber: {
@@ -235,8 +235,8 @@ export function generateSchema(docs = {}) {
         type: "object",
         properties: {
           package: {
-            description:
-              "Use this property to set the <a href='https://developer.android.com/studio/build/application-id'>application ID</a> of the APK. The value is set to `applicationId` in `build.gradle`.",
+            description: extractBrief(docs["android.package"]),
+            markdownDescription: docs["android.package"],
             type: "string",
           },
           versionCode: {

diff --git a/scripts/types.ts b/scripts/types.ts
@@ -199,9 +199,11 @@ export type Docs = {
   singleApp: string;
   version: string;
   "android.icons": string;
+  "android.package": string;
   "android.signingConfigs": string;
   "android.versionCode": string;
   "ios.buildNumber": string;
+  "ios.bundleIdentifier": string;
   "ios.codeSignEntitlements": string;
   "ios.codeSignIdentity": string;
   "ios.developmentTeam": string;