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

chore: Adding local testing steps to contributing guide #1743

Merged
merged 3 commits into from Nov 10, 2022
Merged

chore: Adding local testing steps to contributing guide #1743

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51923ef
chore: Adding local testing steps to contributing guide
ddixit14 Nov 8, 2022
346bb81
Update CONTRIBUTING.md
ddixit14 Nov 8, 2022
bc63ef2
Merge branch 'main' into add-to-guide
bcoe Nov 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 22 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Expand Up @@ -55,4 +55,25 @@ accept your pull requests.

npm run fix

[node]: https://nodejs.org/en/
## 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].

The below command should be run from the root of the source code:

```
node build/src/bin/release-please.js release-pr \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now it's clear. Thank you.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build/src/bin/release-please.js? Not typescript?

--token=$GITHUB_TOKEN \
--repo-url=<owner>/<repo> [extra options]
```

It is equivalent to running the CLI command:

```
release-please release-pr \
--token=$GITHUB_TOKEN \
--repo-url=<owner>/<repo> [extra options]
```

[node]: https://nodejs.org/en/
[CLI]: https://github.com/googleapis/release-please/blob/main/docs/cli.md/