Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs): 📝 Adding missing docs for include-component-in-tag #1855

Merged
merged 2 commits into from
Mar 7, 2023
Merged

fix(docs): 📝 Adding missing docs for include-component-in-tag #1855

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa94ef0
fix(docs): :memo: Adding missing docs for include-component-in-tag
whizzzkid Feb 16, 2023
ccebfaf
Merge branch 'main' into fix/doc-include-component-in-tag
chingor13 Mar 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 28 additions & 3 deletions docs/manifest-releaser.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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"
Expand All @@ -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
<component-name>-v<release-version>
```

In your specific tagging scheme, your tags could like `v<release-version>`. And
this will result in an error like:

```sh
❯ looking for tagName: <component>-v<release-version>
⚠ 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<release-version>
```

## Manifest

At a minimum, a manifest file must exist at the tip of the `--target-branch`.
Expand Down