From 03b5a15f28132c2db455b5ce5fde9773ef480820 Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Tue, 26 Nov 2024 02:07:29 -0500 Subject: [PATCH] chore: version details and history (#4935) * chore: version details and history * Update * Remove 2.x, 3.x * next-8 * npm next-8 * Deprecate 5.x * Add helm charts --- README.md | 19 +++++++++++-------- SECURITY.md | 11 +---------- VERSIONS.md | 23 +++++++++++++++++++++++ 3 files changed, 35 insertions(+), 18 deletions(-) create mode 100644 VERSIONS.md diff --git a/README.md b/README.md index c55b1f14a..7dc6dff27 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,11 @@ ![verdaccio gif](https://cdn.verdaccio.dev/readme/readme-website.png) -# Version Next (Development branch) +# Version Next (Development Branch) -> Looking for Verdaccio 6 version? Check the branch `6.x` -> The plugins for the `v6.x` that are hosted within this organization are located -> at the [`verdaccio/monorepo`](https://github.com/verdaccio/monorepo) repository, while for the `next` version -> are hosted on this project `./packages/plugins`. +> Looking for Verdaccio version 5 or 6? Version 6 is the latest version and successor to version 5. Version 6 requires Node.js 18 or higher and is maintained in the `6.x` branch. + +> The plugins for versions 5 and 6 are located at the [`verdaccio/monorepo`](https://github.com/verdaccio/monorepo) repository. Plugins for the `next-8` version are hosted in this project under the `./packages/plugins` folder. > Note that contributing guidelines might be different based on the branch. @@ -36,6 +35,10 @@ Google Cloud Storage** or create your own plugin. [![Github](https://img.shields.io/github/stars/verdaccio/verdaccio.svg?style=social&label=Stars)](https://github.com/verdaccio/verdaccio/stargazers) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) +## Versions + +You can find more details about the different versions of Verdaccio, minimum requirements, as well as links to associated npm packages and docker images in the [version history](VERSIONS.md). + ## Install > Node.js v18 as minimum version required @@ -43,19 +46,19 @@ Google Cloud Storage** or create your own plugin. Install with npm: ```bash -npm install -g verdaccio@next +npm install -g verdaccio@next-8 ``` With `yarn` ```bash -yarn global add verdaccio@next +yarn global add verdaccio@next-8 ``` With `pnpm` ```bash -pnpm i -g verdaccio@next +pnpm i -g verdaccio@next-8 ``` or diff --git a/SECURITY.md b/SECURITY.md index 0b8dcae48..d316cd6a4 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,16 +2,7 @@ ## Supported versions -The following table describes the versions of this project that are currently supported with security updates: - -| Version | Supported | -| -------- | ----------------------------------- | -| 2.x | :x: | -| 3.x | :x: | -| 4.x | :x: | -| 5.x | :white_check_mark: (until Nov 2024) | -| 6.x | :white_check_mark: | -| 7.x next | :x: | +You can find details about the supported versions of Verdaccio in the [version history](VERSIONS.md). ## Responsible disclosure security policy diff --git a/VERSIONS.md b/VERSIONS.md new file mode 100644 index 000000000..806d663dc --- /dev/null +++ b/VERSIONS.md @@ -0,0 +1,23 @@ +# Versions + +The following table describes the versions of this project: + +| Version | Supported | Minimum Node.js | Branch | Npm Tag | Docker Images | Helm Charts | +| ---------------- | -------------------| --------------- | ------ | ---------------- | ----------------------- | ----------- | +| 4.x | :x: (deprecated) | 10 | 4.x | latest-4 | 4, 4.x, 4.x.x, 4.x-next | 3.x | +| 5.x previous | :x: (deprecated) | 14 | 5.x | latest-5 | 5, 5.x, 5.x.x, 5.x-next | 4.0 - 4.18 | +| 6.x current | :white_check_mark: | 18 | 6.x | latest-6, latest | 6, 6.x, 6.x.x, 6.x-next | 4.19 - ... | +| 7.x next | :x: | 18 | 7.x | next-7 | 7.x-next | n/a | +| 8.x experimental | :x: | 18 | master | next-8 | nightly-master | n/a | + +## Npm Registry + +The official Verdaccio npm packages are located at https://www.npmjs.com/package/verdaccio. + +## Docker Hub + +The official Verdaccio Docker Images are found at https://hub.docker.com/r/verdaccio/verdaccio. + +## Helms Charts + +The official Verdaccio Helm Charts are found at https://artifacthub.io/packages/helm/verdaccio/verdaccio.