Prepare release v0.4.0 (#121)

cloud-annotations · Dec 23, 2021 · ef53cfd · ef53cfd
1 parent 467ae29
commit ef53cfd
Show file tree

Hide file tree

Showing 7 changed files with 74 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,62 @@
+## 0.4.0 (Dec 23, 2021)
+
+High level enhancements
+
+- Docusaurus beta.14 support
+
+  ```js
+  // Be sure to update @docusaurus/core:
+  "dependencies": {
+    "@docusaurus/core": "2.0.0-beta.14",
+    // ...
+  }
+  ```
+
+- With the release of Docusaurus beta.14 (Thanks @slorber!), we can now support configuration of `webpack-dev-server`'s proxy via our `docusaurus-plugin-proxy` plugin.
+
+  This can be useful when you have a separate API backend development server and you want to send API requests on the same domain.
+
+  With the following, a request to `/api/users` will now proxy the request to `http://localhost:3001/api/users`:
+
+  ```js
+  // docusaurus.config.js
+
+  const config = {
+    plugins: [["docusaurus-plugin-proxy", { "/api": "http://localhost:3001" }]],
+    // ...
+  };
+  ```
+
+  To proxy `/api/users` to `http://localhost:3001/users`, the path can be rewritten:
+
+  ```js
+  // docusaurus.config.js
+
+  const config = {
+    plugins: [
+      [
+        "docusaurus-plugin-proxy",
+        {
+          "/api": {
+            target: "http://localhost:3001",
+            pathRewrite: { "^/api": "" },
+          },
+        },
+      ],
+    ],
+    // ...
+  };
+  ```
+
+  For more config options, see [devServer.proxy](https://webpack.js.org/configuration/dev-server/#devserverproxy).
+
+- Better yarn 3 support
+
+Other enhancements and bug fixes
+
+- Bump to beta 14 and fix proxy plugin ([#120](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/120))
+- Fix dependency resolutions ([#119](https://github.com/cloud-annotations/docusaurus-plugin-openapi/pull/119))
+
 ## 0.3.1 (Dec 21, 2021)
 
 High level enhancements

diff --git a/demo/package.json b/demo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "demo",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -18,7 +18,7 @@
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
-    "docusaurus-preset-openapi": "^0.3.1",
+    "docusaurus-preset-openapi": "^0.4.0",
     "file-loader": "^6.2.0",
     "prism-react-renderer": "^1.2.1",
     "react": "^17.0.1",

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.3.1",
+  "version": "0.4.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }
diff --git a/packages/docusaurus-plugin-openapi/package.json b/packages/docusaurus-plugin-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -17,9 +17,9 @@
     "@docusaurus/types": "^2.0.0-beta.14",
     "@types/fs-extra": "^9.0.13",
     "@types/js-yaml": "^4.0.5",
+    "@types/json-schema": "^7.0.9",
     "@types/lodash": "^4.14.176",
     "@types/postman-collection": "^3.5.3",
-    "@types/json-schema": "^7.0.9",
     "utility-types": "^3.10.0"
   },
   "dependencies": {

diff --git a/packages/docusaurus-plugin-proxy/package.json b/packages/docusaurus-plugin-proxy/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-proxy",
   "description": "A dev server proxy for Docusaurus.",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -13,8 +13,8 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@types/webpack-dev-server": "^4.5.0",
-    "@docusaurus/types": "^2.0.0-beta.14"
+    "@docusaurus/types": "^2.0.0-beta.14",
+    "@types/webpack-dev-server": "^4.5.0"
   },
   "engines": {
     "node": ">=14"

diff --git a/packages/docusaurus-preset-openapi/package.json b/packages/docusaurus-preset-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-preset-openapi",
   "description": "OpenAPI preset for Docusaurus.",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -29,9 +29,9 @@
   },
   "dependencies": {
     "@docusaurus/preset-classic": "^2.0.0-beta.14",
-    "docusaurus-plugin-openapi": "^0.3.1",
-    "docusaurus-plugin-proxy": "^0.3.1",
-    "docusaurus-theme-openapi": "^0.3.1"
+    "docusaurus-plugin-openapi": "^0.4.0",
+    "docusaurus-plugin-proxy": "^0.4.0",
+    "docusaurus-theme-openapi": "^0.4.0"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",

diff --git a/packages/docusaurus-theme-openapi/package.json b/packages/docusaurus-theme-openapi/package.json
@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -29,12 +29,12 @@
   "dependencies": {
     "@mdx-js/react": "^1.6.21",
     "@monaco-editor/react": "^4.3.1",
-    "monaco-editor": "^0.31.1",
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
-    "docusaurus-plugin-openapi": "^0.3.1",
+    "docusaurus-plugin-openapi": "^0.4.0",
     "immer": "^9.0.6",
     "lodash": "^4.17.20",
+    "monaco-editor": "^0.31.1",
     "postman-code-generators": "^1.0.0",
     "postman-collection": "^4.1.0",
     "prism-react-renderer": "^1.2.1",