docs: add troubleshooting page #1752
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bcoe
suggested changes
Nov 18, 2022
docs/troubleshooting.md
Outdated
| The easiest way to debug your `release-please` configuration is to use the bundled | ||
| CLI. | ||
|
|
||
| To use the CLI, you will need to use a GitHub personal access token: |
There was a problem hiding this comment.
I would link to creating a personal access token:
|
|
||
| ```bash | ||
| export GITHUB_TOKEN="my-access-token" | ||
| release-please release-pr \ |
There was a problem hiding this comment.
Since many folks using the tool are non JavaScript users, I would add a section on:
"Setting up your environment", which links to nvm and explains they will need to:
- git clone the repository.
- setup Node.js with nvm.
- npm i
- npm link .
There was a problem hiding this comment.
I don't think it's necessary to teach folks how to install node.
bcoe
approved these changes
Nov 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1687