Skip to content

Commit 09ae5a2

Browse files
ddixit14Benjamin E. Coe
andauthored
docs: Adding local testing steps to contributing guide (googleapis#1743)
* chore: Adding local testing steps to contributing guide * Update CONTRIBUTING.md Co-authored-by: Benjamin E. Coe <[email protected]>
1 parent 2d9d5b6 commit 09ae5a2

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,25 @@ accept your pull requests.
5555

5656
npm run fix
5757

58-
[node]: https://nodejs.org/en/
58+
## Testing a new feature using CLI
59+
60+
1. After you've written some new code, in order to test it out, you can use the [CLI][CLI].
61+
62+
The below command should be run from the root of the source code:
63+
64+
```
65+
node build/src/bin/release-please.js release-pr \
66+
--token=$GITHUB_TOKEN \
67+
--repo-url=<owner>/<repo> [extra options]
68+
```
69+
70+
It is equivalent to running the CLI command:
71+
72+
```
73+
release-please release-pr \
74+
--token=$GITHUB_TOKEN \
75+
--repo-url=<owner>/<repo> [extra options]
76+
```
77+
78+
[node]: https://nodejs.org/en/
79+
[CLI]: https://github.com/googleapis/release-please/blob/main/docs/cli.md/

0 commit comments

Comments
 (0)