From aa94ef092a18472a3c4de52ea02ac16c40c3ab8a Mon Sep 17 00:00:00 2001 From: Nishant Arora <1895906+whizzzkid@users.noreply.github.com> Date: Thu, 16 Feb 2023 02:08:47 -0700 Subject: [PATCH] fix(docs): :memo: Adding missing docs for include-component-in-tag --- docs/manifest-releaser.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/docs/manifest-releaser.md b/docs/manifest-releaser.md index 87eaa7179..07700523b 100644 --- a/docs/manifest-releaser.md +++ b/docs/manifest-releaser.md @@ -239,7 +239,7 @@ defaults (those are documented in comments) // large numbers of packages at once. // absence defaults to false, causing calls to be issued concurrently. "sequential-calls": false, - + // per package configuration: at least one entry required. // the key is the relative path from the repo root to the folder that contains @@ -263,7 +263,7 @@ defaults (those are documented in comments) // overrides release-type for node "release-type": "node", }, - + // path segment should be relative to repository root "path/to/myJSPkgA": { // overrides release-type for node @@ -296,7 +296,7 @@ defaults (those are documented in comments) // our change log is located at path/to/myPyPkgA/docs/CHANGES.rst "changelog-path": "docs/CHANGES.rst" }, - + "path/to/github-enterprise-package", { // override changelog host for github enterprise package "changelog-host": "https://example.com" @@ -306,6 +306,31 @@ defaults (those are documented in comments) } ``` +## Subsequent Versions + +release-please tries to determine the next release based on the previous tagged +release. The default search tag looks like: + +```sh +-v +``` + +In your specific tagging scheme, your tags could like `v`. And +this will result in an error like: + +```sh +❯ looking for tagName: -v +⚠ Expected 1 releases, only found 0 +``` + +To fix this, component can be removed from tagName being searched using the +`include-component-in-tag` property. Setting this to `false` will change the +tagName to: + +```sh +v +``` + ## Manifest At a minimum, a manifest file must exist at the tip of the `--target-branch`.