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: Describe how to install canary versions #6046

Closed
2 tasks done
JoshuaKGoldberg opened this issue Nov 20, 2022 · 0 comments · Fixed by #6248
Closed
2 tasks done

Docs: Describe how to install canary versions #6046

JoshuaKGoldberg opened this issue Nov 20, 2022 · 0 comments · Fixed by #6248
Assignees
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

We mention in https://github.com/typescript-eslint/typescript-eslint/tree/a4f85b8cfe38ba8ea2a2ac4a56d9b11a81a8a15a#versioning that you can download and install the latest nightly release in the canary branch. But we never actually say how to do that.

Trying out locally, I find myself having to use a --force flag when installing with npm:

npm i @typescript-eslint/eslint-plugin@canary @typescript-eslint/parser@canary --save-dev --force

Yarn doesn't seem to need that:

yarn add @typescript-eslint/eslint-plugin@canary @typescript-eslint/parser@canary --save-dev

We should document this on the site. Especially for situations like #5688 where many people want to use the canary version, it should be clear for people how to.

Affected URL(s)

Right now, https://github.com/typescript-eslint/typescript-eslint#versioning. After #5984, perhaps an independent page?

@JoshuaKGoldberg JoshuaKGoldberg added documentation Documentation ("docs") that needs adding/updating accepting prs Go ahead, send a pull request that resolves this issue labels Nov 20, 2022
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Nov 20, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 31, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant