From 51923efc2b55ade11e1d0b5ac6653fdaf786ee22 Mon Sep 17 00:00:00 2001 From: deepankar Date: Tue, 8 Nov 2022 14:16:33 +0000 Subject: [PATCH 1/2] chore: Adding local testing steps to contributing guide --- CONTRIBUTING.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47931d23b..b05dfd5fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,4 +55,25 @@ accept your pull requests. npm run fix -[node]: https://nodejs.org/en/ \ No newline at end of file +## Testing a new feature using CLI + +1. After you've written some new code, in order to test it out, you can use the [CLI][CLI]. + + For example, the CLI command: + + ``` + release-please release-pr \ + --token=$GITHUB_TOKEN \ + --repo-url=/ [extra options] + ``` + + can be run as from the root of the source code as: + + ``` + node build/src/bin/release-please.js release-pr \ + --token=$GITHUB_TOKEN \ + --repo-url=/ [extra options] + ``` + +[node]: https://nodejs.org/en/ +[CLI]: https://github.com/googleapis/release-please/blob/main/docs/cli.md/ \ No newline at end of file From 346bb810522ac5e953982a602d4377d159b6beb9 Mon Sep 17 00:00:00 2001 From: Deepankar Dixit <90280028+ddixit14@users.noreply.github.com> Date: Tue, 8 Nov 2022 12:27:00 -0500 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b05dfd5fb..2591549ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,21 +59,21 @@ accept your pull requests. 1. After you've written some new code, in order to test it out, you can use the [CLI][CLI]. - For example, the CLI command: + The below command should be run from the root of the source code: ``` - release-please release-pr \ + node build/src/bin/release-please.js release-pr \ --token=$GITHUB_TOKEN \ --repo-url=/ [extra options] ``` - - can be run as from the root of the source code as: + + It is equivalent to running the CLI command: ``` - node build/src/bin/release-please.js release-pr \ + release-please release-pr \ --token=$GITHUB_TOKEN \ --repo-url=/ [extra options] ``` [node]: https://nodejs.org/en/ -[CLI]: https://github.com/googleapis/release-please/blob/main/docs/cli.md/ \ No newline at end of file +[CLI]: https://github.com/googleapis/release-please/blob/main/docs/cli.md/