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

docs: update manifest-releaser docs to add some clarification around … #2331

Merged
merged 3 commits into from
Sep 11, 2024
Merged

docs: update manifest-releaser docs to add some clarification around … #2331

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d5994b5
docs: update manifest-releaser docs to add some clarification around …
sysadmiral Jul 9, 2024
00c1aca
Merge branch 'main' into add_clarification_around_package_path
chingor13 Sep 11, 2024
e5f427f
Update manifest-releaser.md
chingor13 Sep 11, 2024
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
10 changes: 8 additions & 2 deletions docs/manifest-releaser.md
View file
Open in desktop
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
Loading