@fluidframework/fluid-runner 2.1.0-281041 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluidframework/fluid-runner
 
+## 2.2.0
+
+Dependency updates only.
+
+## 2.1.0
+
+Dependency updates only.
+
 ## 2.0.0-rc.5.0.0
 
 ### Minor Changes

package/README.md

@@ -2,6 +2,40 @@
 
 This package contains utility for running various functionality inside a Fluid Framework environment.
 
+<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER:apiDocs=FALSE) -->
+
+<!-- prettier-ignore-start -->
+<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
+
+## Using Fluid Framework libraries
+
+When taking a dependency on a Fluid Framework library's public APIs, we recommend using a `^` (caret) version range, such as `^1.3.4`.
+While Fluid Framework libraries may use different ranges with interdependencies between other Fluid Framework libraries,
+library consumers should always prefer `^`.
+
+If using any of Fluid Framework's unstable APIs (for example, its `beta` APIs), we recommend using a more constrained version range, such as `~`.
+
+## Installation
+
+To get started, install the package by running the following command:
+
+```bash
+npm i @fluidframework/fluid-runner
+```
+
+## Importing from this package
+
+This package leverages [package.json exports](https://nodejs.org/api/packages.html#exports) to separate its APIs by support level.
+For more information on the related support guarantees, see [API Support Levels](https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels).
+
+To access the `public` ([SemVer](https://semver.org/)) APIs, import via `@fluidframework/fluid-runner` like normal.
+
+To access the `legacy` APIs, import via `@fluidframework/fluid-runner/legacy`.
+
+<!-- prettier-ignore-end -->
+
+<!-- AUTO-GENERATED-CONTENT:END -->
+
 ## Export File
 
 Allows some execution to be made on a container given a provided ODSP snapshot.
@@ -83,11 +117,37 @@ The code around `exportFile` can be consumed in multiple different layers. It is
 
 For an example of a consumption path that differs slightly to [`exportFile(...)`](./src/exportFile.ts), see [`parseBundleAndExportFile(...)`](./src/parseBundleAndExportFile.ts). In addition to running the same logic as [`exportFile`](./src/exportFile.ts) method, it implements the logic around parsing a dynamically provided bundle path into an `IFluidFileConverter` object.
 
-<!-- AUTO-GENERATED-CONTENT:START (README_TRADEMARK_SECTION:includeHeading=TRUE) -->
+<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER:clientRequirements=FALSE) -->
 
 <!-- prettier-ignore-start -->
 <!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
 
+## Contribution Guidelines
+
+There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
+
+-   Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
+-   [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
+-   Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
+-   [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
+
+Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
+Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+
+## Help
+
+Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
+
+Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
+
+Thank you!
+
 ## Trademark
 
 This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-runner",
-  "version": "2.1.0-281041",
+  "version": "2.2.0",
   "description": "Utility for running various functionality inside a Fluid Framework environment",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,26 +69,26 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "2.1.0-281041",
-    "@fluidframework/container-definitions": "2.1.0-281041",
-    "@fluidframework/container-loader": "2.1.0-281041",
-    "@fluidframework/core-interfaces": "2.1.0-281041",
-    "@fluidframework/driver-definitions": "2.1.0-281041",
-    "@fluidframework/odsp-driver": "2.1.0-281041",
-    "@fluidframework/odsp-driver-definitions": "2.1.0-281041",
-    "@fluidframework/telemetry-utils": "2.1.0-281041",
+    "@fluidframework/aqueduct": "~2.2.0",
+    "@fluidframework/container-definitions": "~2.2.0",
+    "@fluidframework/container-loader": "~2.2.0",
+    "@fluidframework/core-interfaces": "~2.2.0",
+    "@fluidframework/driver-definitions": "~2.2.0",
+    "@fluidframework/odsp-driver": "~2.2.0",
+    "@fluidframework/odsp-driver-definitions": "~2.2.0",
+    "@fluidframework/telemetry-utils": "~2.2.0",
     "json2csv": "^5.0.7",
     "yargs": "17.7.2"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "~1.8.3",
-    "@fluid-internal/mocha-test-setup": "2.1.0-281041",
-    "@fluid-tools/build-cli": "^0.40.0",
+    "@fluid-internal/mocha-test-setup": "~2.2.0",
+    "@fluid-tools/build-cli": "^0.43.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.40.0",
+    "@fluidframework/build-tools": "^0.43.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/fluid-runner-previous": "npm:@fluidframework/fluid-runner@2.0.0",
+    "@fluidframework/fluid-runner-previous": "npm:@fluidframework/fluid-runner@2.1.0",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",