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

Examples for Yarn 1 (Classic) and Yarn Berry / Modern (Version 2 and later) #799

Closed
MikeMcC399 opened this issue Feb 17, 2023 · 4 comments
Closed
Labels
type: feature feature request

Comments

@MikeMcC399
Copy link
Collaborator

MikeMcC399 commented Feb 17, 2023

This is an enhancement request to add examples to clearly demonstrate using GHA for both Yarn 1 (Classic) and Yarn Berry / Modern (Version 2 and later).

Current situation

The following workflows and example directories target yarn:

The examples demonstrate only Yarn 1 (Classic).

Suggestion

Create new workflows with yarn in their names so that they are easily identified:
- Yarn 1 (Classic) example-yarn-classic
- Yarn Modern example-yarn-modern

Naming

Note that both terms Yarn Berry and Yarn Modern are in use and equivalent.

The GitHub repository https://github.com/yarnpkg/berry is named with the term berry. It includes releases for Yarn version 2 onwards. The site https://yarnpkg.com/ includes the note "This documentation covers modern versions of Yarn.", introducing the term "modern". The page https://yarnpkg.com/getting-started/qa#why-should-you-upgrade-to-yarn-modern more specifically uses the terms Yarn Classic and Yarn Modern side-by-side when discussing migration.

I suggest to use the term Yarn Modern, when referring to Yarn version 2 and later, in preference to the term Yarn Berry. The term Yarn Modern is immediately recognizable as being a later version than Yarn Classic without the need for any reference materials.

Related documentation issue

@MikeMcC399
Copy link
Collaborator Author

Assuming agreement, I plan to submit a PR to implement this enhancement request.

@nagash77 nagash77 added the type: feature feature request label Feb 17, 2023
@MikeMcC399
Copy link
Collaborator Author

MikeMcC399 commented Mar 9, 2023

I've been reviewing my suggestion and I plan to split it into two parts:

  1. Establish a Yarn Classic example clearly labeled
  2. Add a Yarn Modern example, piggy-backed on the Yarn Classic example

otherwise it will be unduly complex and difficult to review.

@MikeMcC399 MikeMcC399 changed the title Examples for Yarn 1 (Classic) and Yarn Berry (Version 2 and later) Examples for Yarn 1 (Classic) and Yarn Berry / Modern (Version 2 and later) Mar 11, 2023
@MikeMcC399
Copy link
Collaborator Author

@MikeMcC399
Copy link
Collaborator Author

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

No branches or pull requests

3 participants