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

Add docs to consume preview packages #544

Merged
merged 8 commits into from
May 24, 2022

Conversation

timotheeguerin
Copy link
Member

fix #494

@azure-pipelines
Copy link

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/544/

Copy link
Contributor

@markcowl markcowl left a comment

Choose a reason for hiding this comment

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

One question and a couple of minor suggested clarifications

README.md Outdated
On every commit to the main branch, packages with changes are automatically packaged and published under the `@next` tag under npm.
In the [packages](#packages) section each package has a `@next` tag which show its current next version.

To use a `nightly` version of the packages update go over each one of the packages in the `package.json` fie and update it to either the latest published `@next` version or `@latest`, which ever is the newest. (You can also use the tag `latest` or `next`)
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we saying that they can use the tag 'next' or 'latest' in their package.json files? Or do we want them to be explicit about version and not use the tags?

Copy link
Member Author

Choose a reason for hiding this comment

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

They can use either. For next I think it doesn't matter, next be maybe simpler. For latest we maybe should decide when we go to 1.0 if we want people to try to always use the latest version or be tied to a major, minor version

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
timotheeguerin and others added 2 commits May 18, 2022 16:43
Co-authored-by: Mark Cowlishaw <[email protected]>
Co-authored-by: Mark Cowlishaw <[email protected]>
Copy link
Member

@bterlson bterlson left a comment

Choose a reason for hiding this comment

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

Wording suggestions you can take or leave.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
timotheeguerin and others added 5 commits May 23, 2022 10:13
@timotheeguerin timotheeguerin merged commit 746620a into microsoft:main May 24, 2022
@timotheeguerin timotheeguerin deleted the docs/preview-packages branch May 24, 2022 17:32
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.

Investigate issue with @next version and peerDependencies
3 participants