From 7eba85ab758421a2b5207a5db9d6fe2f6d8b94be Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Tue, 20 Aug 2024 17:23:47 -0400 Subject: [PATCH] Prepare relesae v4.0.0 --- CHANGELOG.md | 12 ++++++++++++ README.md | 7 ++++--- demo/docs/intro.mdx | 7 ++++--- demo/package.json | 6 +++--- lerna.json | 2 +- packages/docusaurus-plugin-openapi-docs/README.md | 7 ++++--- packages/docusaurus-plugin-openapi-docs/package.json | 2 +- packages/docusaurus-theme-openapi-docs/package.json | 4 ++-- 8 files changed, 31 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f0a9ec61..f5e8e202c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +## 4.0.0 (Aug 20, 2024) + +High level enhancements + +- Introduce support for Docusaurus 3.5.0+ + +> Note that this breaks backward compatibility and users will need to update their Docusaurus installation to 3.5.0 or later to use this version of the plugin. + +Other enhancements and bug fixes + +- Introduce support for Docusaurus 3.5.0+ ([#919](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/919)) + ## 3.0.2 (Aug 14, 2024) High level enhancements diff --git a/README.md b/README.md index bd548bb4f..9278e7db9 100644 --- a/README.md +++ b/README.md @@ -41,16 +41,17 @@ Key Features: | Docusaurus OpenAPI Docs | Docusaurus | | ----------------------- | --------------- | -| 3.0.2 (current) | `3.0.1 - 3.4.0` | +| 4.0.0 (current) | `3.5.0 - 3.5.2` | +| 3.0.2 (legacy) | `3.0.1 - 3.4.0` | | 2.2.1 (legacy) | `2.4.1 - 2.4.3` | -| 1.7.3 (legacy) | `2.0.1 - 2.2.0` | +| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` | ## Bootstrapping from Template (new Docusaurus site) Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash -npx create-docusaurus@3.4.0 my-website --package-manager yarn +npx create-docusaurus@3.5.2 my-website --package-manager yarn ``` > When prompted to select a template choose `Git repository`. diff --git a/demo/docs/intro.mdx b/demo/docs/intro.mdx index 9ae23a599..a81fab3c9 100644 --- a/demo/docs/intro.mdx +++ b/demo/docs/intro.mdx @@ -58,9 +58,10 @@ Key Features: | Docusaurus OpenAPI Docs | Docusaurus | | ----------------------- | --------------- | -| 3.0.2 (current) | `3.0.1 - 3.4.0` | +| 4.0.0 (current) | `3.5.0 - 3.5.2` | +| 3.0.2 (legacy) | `3.0.1 - 3.4.0` | | 2.2.1 (legacy) | `2.4.1 - 2.4.3` | -| 1.7.3 (legacy) | `2.0.1 - 2.2.0` | +| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` | :::tip @@ -72,7 +73,7 @@ If you"re building a Docusaurus site from scratch the easiest way to get started Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`: ```bash -npx create-docusaurus@3.4.0 my-website --package-manager yarn +npx create-docusaurus@3.5.2 my-website --package-manager yarn ``` > When prompted to select a template choose `Git repository`. diff --git a/demo/package.json b/demo/package.json index b6c19de81..e3a8faf33 100644 --- a/demo/package.json +++ b/demo/package.json @@ -1,6 +1,6 @@ { "name": "demo", - "version": "3.0.2", + "version": "4.0.0", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -25,8 +25,8 @@ "@docusaurus/plugin-google-gtag": "3.5.2", "@docusaurus/preset-classic": "3.5.2", "clsx": "^1.1.1", - "docusaurus-plugin-openapi-docs": "^3.0.2", - "docusaurus-theme-openapi-docs": "^3.0.2", + "docusaurus-plugin-openapi-docs": "^4.0.0", + "docusaurus-theme-openapi-docs": "^4.0.0", "prism-react-renderer": "^2.3.0", "react": "^18.2.0", "react-dom": "^18.2.0" diff --git a/lerna.json b/lerna.json index 59dcb8cad..5a30cf2f8 100644 --- a/lerna.json +++ b/lerna.json @@ -1,4 +1,4 @@ { - "version": "3.0.2", + "version": "4.0.0", "npmClient": "yarn" } diff --git a/packages/docusaurus-plugin-openapi-docs/README.md b/packages/docusaurus-plugin-openapi-docs/README.md index 0434b291a..3ee1b3fac 100644 --- a/packages/docusaurus-plugin-openapi-docs/README.md +++ b/packages/docusaurus-plugin-openapi-docs/README.md @@ -41,16 +41,17 @@ Key Features: | Docusaurus OpenAPI Docs | Docusaurus | | ----------------------- | --------------- | -| 3.0.2 (current) | `3.0.1 - 3.4.0` | +| 4.0.0 (current) | `3.5.0 - 3.5.2` | +| 3.0.2 (legacy) | `3.0.1 - 3.4.0` | | 2.2.1 (legacy) | `2.4.1 - 2.4.3` | -| 1.7.3 (legacy) | `2.0.1 - 2.2.0` | +| 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` | ## Bootstrapping from Template (new Docusaurus site) Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash -npx create-docusaurus@3.4.0 my-website --package-manager yarn +npx create-docusaurus@3.5.2my-website --package-manager yarn ``` > When prompted to select a template choose `Git repository`. diff --git a/packages/docusaurus-plugin-openapi-docs/package.json b/packages/docusaurus-plugin-openapi-docs/package.json index e3df1d379..6e0002330 100644 --- a/packages/docusaurus-plugin-openapi-docs/package.json +++ b/packages/docusaurus-plugin-openapi-docs/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-plugin-openapi-docs", "description": "OpenAPI plugin for Docusaurus.", - "version": "3.0.2", + "version": "4.0.0", "license": "MIT", "keywords": [ "openapi", diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index 6d96a3304..57175eab1 100644 --- a/packages/docusaurus-theme-openapi-docs/package.json +++ b/packages/docusaurus-theme-openapi-docs/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-theme-openapi-docs", "description": "OpenAPI theme for Docusaurus.", - "version": "3.0.2", + "version": "4.0.0", "license": "MIT", "keywords": [ "openapi", @@ -42,7 +42,7 @@ "clsx": "^1.1.1", "copy-text-to-clipboard": "^3.1.0", "crypto-js": "^4.1.1", - "docusaurus-plugin-openapi-docs": "^3.0.2", + "docusaurus-plugin-openapi-docs": "^4.0.0", "docusaurus-plugin-sass": "^0.2.3", "file-saver": "^2.0.5", "lodash": "^4.17.20",