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.

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

docs: add debugging/troubleshooting guide #5212

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

nettyso
Copy link
Contributor

@nettyso nettyso commented Jan 23, 2023

What's the problem this PR addresses?

Closes #5085. Mentions #5156.

The rationale is: I was trying to migrate from Yarn v1 to Yarn Berry and ran into an error. There are no good docs for how to deal with a stacktrace: the lack of docs was uncomfortable as an end user. So I wrote some docs!

I'm not a docs writer but I took screenshots soooo hopefully it makes sense.

P.S I noticed you're not using Git LFS, so I just uploaded the images as-is since there's already a precedent for that.
...

How did you fix it?

N/A
...

Checklist

  • I have set the packages that need to be released for my changes to be effective. N/A
  • I will check that all automated PR checks pass before the PR gets reviewed.

@nettyso nettyso changed the title Add docs for debugging Yarn docs: add debugging/troubleshooting guide Jan 23, 2023
Comment on lines +34 to +53
Start on the releases page: https://github.com/yarnpkg/berry/releases/

![](/unminified-yarn-01.png)

Choose a release to download:

![](/unminified-yarn-02.png)

Find the CI pipeline that built the artifacts and navigate to its "Summary" tab. The artifacts are at the bottom of the page.

![](/unminified-yarn-03.png)
![](/unminified-yarn-04.png)
![](/unminified-yarn-05.png)

Unzip the artifacts and move the `yarn.js` somewhere memorable such as `<root>/.yarn/releases/yarn-3.3.0-github-artifact.js`. Finally, point your `.yarnrc.yml` to this new release:

```yml
# yarnPath: .yarn/releases/yarn-3.3.0.cjs
yarnPath: .yarn/releases/yarn-3.3.0-artifact.js
```
Copy link
Contributor

Choose a reason for hiding this comment

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

This whole section can be replaced with a single command:

yarn set version from sources --branch @yarnpkg/cli/<Your Version> --no-minify

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug?]: No migration troubleshooting docs for error ... isn't supported by any available resolver
2 participants