From 058860593aa833aa52e187d66bcfc507fdff219e Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Sun, 2 Feb 2025 11:02:14 +0100 Subject: [PATCH] chore: `keep_readmes` docs (#5052) * chore: `keep_readmes` docs * clean-up type * fix indent (tab to space) --- .changeset/brown-planets-approve.md | 7 +++++++ packages/config/src/conf/default.yaml | 11 ++++++----- packages/config/src/conf/docker.yaml | 11 ++++++----- packages/core/types/src/configuration.ts | 4 ++-- website/docs/config.md | 15 ++++++++++++--- website/versioned_docs/version-6.x/config.md | 6 +++--- 6 files changed, 36 insertions(+), 18 deletions(-) create mode 100644 .changeset/brown-planets-approve.md diff --git a/.changeset/brown-planets-approve.md b/.changeset/brown-planets-approve.md new file mode 100644 index 000000000..8a24d68cb --- /dev/null +++ b/.changeset/brown-planets-approve.md @@ -0,0 +1,7 @@ +--- +'@verdaccio/config': patch +'@verdaccio/types': patch +'@verdaccio/website': patch +--- + +chore: `keep_readmes` docs diff --git a/packages/config/src/conf/default.yaml b/packages/config/src/conf/default.yaml index e90ee95e3..7faafbecf 100644 --- a/packages/config/src/conf/default.yaml +++ b/packages/config/src/conf/default.yaml @@ -121,6 +121,7 @@ server: # publish: # allow_offline: false # check_owners: false +# keep_readmes: 'latest' | 'tagged' | 'all' # https://verdaccio.org/docs/configuration#url-prefix # url_prefix: /verdaccio/ @@ -143,11 +144,11 @@ server: # expiresIn: 29d # verify: # someProp: [value] -# web: -# sign: -# expiresIn: 1h # 1 hour by default -# verify: -# someProp: [value] +# web: +# sign: +# expiresIn: 1h # 1 hour by default +# verify: +# someProp: [value] # https://verdaccio.org/docs/configuration#user-rate-limit # userRateLimit: diff --git a/packages/config/src/conf/docker.yaml b/packages/config/src/conf/docker.yaml index 0aa99f61b..b34abdff2 100644 --- a/packages/config/src/conf/docker.yaml +++ b/packages/config/src/conf/docker.yaml @@ -127,6 +127,7 @@ server: # publish: # allow_offline: false # check_owners: false +# keep_readmes: 'latest' | 'tagged' | 'all' # https://verdaccio.org/docs/configuration#url-prefix # url_prefix: /verdaccio/ @@ -149,11 +150,11 @@ server: # expiresIn: 29d # verify: # someProp: [value] -# web: -# sign: -# expiresIn: 1h # 1 hour by default -# verify: -# someProp: [value] +# web: +# sign: +# expiresIn: 1h # 1 hour by default +# verify: +# someProp: [value] # https://verdaccio.org/docs/configuration#user-rate-limit # userRateLimit: diff --git a/packages/core/types/src/configuration.ts b/packages/core/types/src/configuration.ts index 5d617fb48..3768c07b4 100644 --- a/packages/core/types/src/configuration.ts +++ b/packages/core/types/src/configuration.ts @@ -196,11 +196,11 @@ export interface Security { api: APITokenOptions; } -export type ReadmeOptions = 'latest' | 'tagged' | 'all' | undefined; +export type ReadmeOptions = 'latest' | 'tagged' | 'all'; export interface PublishOptions { allow_offline: boolean; - keep_readmes: ReadmeOptions; + keep_readmes?: ReadmeOptions; check_owners: boolean; } diff --git a/website/docs/config.md b/website/docs/config.md index 2e3461ae3..ed0af71aa 100644 --- a/website/docs/config.md +++ b/website/docs/config.md @@ -129,7 +129,7 @@ security: sign: expiresIn: 1h # 1 hour by default verify: - someProp: [value] + someProp: [value] ``` ### Server {#server} @@ -183,14 +183,14 @@ packages: ### Offline Publish {#offline-publish} -By default `verdaccio` does not allow you to publish packages when the client is offline. This can be overridden by setting this value to _true_. +By default Verdaccio does not allow you to publish packages when the client is offline. This can be overridden by setting this value to _true_. ```yaml publish: allow_offline: false ``` -### Checking Package Ownership {#chec-owner} +### Checking Package Ownership {#check-owner} By default, [package access](packages.md) defines who is allowed to publish and unpublish packages. By setting `check_owners` to _true_, only package owners are allowed to make changes to a package. The first owner of a package is the user who published the first version. Further owners can be added or removed using [`npm owner`](https://docs.npmjs.com/cli/v10/commands/npm-owner). You can find the list of current owners using `npm owner list` or by checking the package manifest under `maintainers`. @@ -199,6 +199,15 @@ publish: check_owners: false ``` +### Keep Readmes {#keep-readmes} + +By default, Verdaccio stores only the readme markdown of the latest version for each package. Setting `keep_readmes` to `'tagged'` keeps the readmes of versions with `dist-tags` (for example, `latest`, `next`, and major branches). Using the `'all'` setting will retain the complete history of readme versions. Note that `'all'` can significantly increase the required storage space for packages published to Verdaccio! + +```yaml +publish: + keep_readmes: 'tagged' +``` + Since: `verdaccio@2.3.6` due [#223](https://github.com/verdaccio/verdaccio/pull/223) ### URL Prefix {#url-prefix} diff --git a/website/versioned_docs/version-6.x/config.md b/website/versioned_docs/version-6.x/config.md index ebd6fae5e..728b5de62 100644 --- a/website/versioned_docs/version-6.x/config.md +++ b/website/versioned_docs/version-6.x/config.md @@ -143,7 +143,7 @@ If verdaccio runs on **Node.js 22** or higher, you will not see this warning sin The **migrateToSecureLegacySignature** property is only available for versions higher than 5.31.0 and is **false** by default. -:::info +::: ```yaml security: @@ -170,7 +170,7 @@ security: sign: expiresIn: 1h # 1 hour by default verify: - someProp: [value] + someProp: [value] ``` ### Server {#server} @@ -224,7 +224,7 @@ packages: ### Offline Publish {#offline-publish} -By default `verdaccio` does not allow you to publish packages when the client is offline. This can be can be overridden by setting this value to _true_. +By default Verdaccio does not allow you to publish packages when the client is offline. This can be can be overridden by setting this value to _true_. ```yaml publish: