Skip to content

Commit

Permalink
docs: update manifest-releaser docs to add some clarification around … (
Browse files Browse the repository at this point in the history
#2331)

* docs: update manifest-releaser docs to add some clarification around the package path

- make it a little clearer that the package path should be a folder and not a file
- give an example for creating an empty release-please-manifest.json

Signed-off-by: Amo Chumber <amo@sysadmiral.xyz>

* Update manifest-releaser.md

---------

Signed-off-by: Amo Chumber <amo@sysadmiral.xyz>
Co-authored-by: Jeff Ching <chingor@google.com>
  • Loading branch information
sysadmiral and chingor13 authored Sep 11, 2024
1 parent dad27e3 commit a4bbce1
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/manifest-releaser.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,13 @@ Create a minimal `release-please-config.json`, e.g., for a single JS package:
}
```

Create an empty `.release-please-manifest.json`
> Note: `path/to/pkg` should be a directory and not a file.
Create an empty `.release-please-manifest.json`. For example:
```shell
echo "{}" > .release-please-manifest.json
```


Commit/push/merge these to your remote GitHub repo (using either the repo's
default branch or a test branch in which case you'll use the `--target-branch`
Expand Down Expand Up @@ -269,7 +275,7 @@ defaults (those are documented in comments)
"exclude-paths": ["path/to/myPyPkgA"]
},

// path segment should be relative to repository root
// path segment should be a folder relative to repository root
"path/to/myJSPkgA": {
// overrides release-type for node
"release-type": "node",
Expand Down

0 comments on commit a4bbce1

Please sign in to comment.