docs: adds version information to storybook #1999
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
|
Thank you for creating a Pull Request @gavinbarron. This is a checklist for the PR reviewer(s) to complete before approving and merging this PR:
|
|
The updated storybook is available here |
|
The updated storybook is available here |
1 similar comment
|
The updated storybook is available here |
|
This is amazing! Glad to see it completed! Works great for me! |
sebastienlevert
approved these changes
Jan 24, 2023
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.
Closes #1413
PR Type
Description of the changes
Adds version info into the storybook site.
This uses 'storybook-version' to pull the version info into the header bar on a per-story basis. This is driven by the existing version.ts file in mgt-element which is now explicitly exported for use.
The overview mdx based story exposes the version information in the npm install step and in the opening section.
The injected footer now also contains version information. This PR also resolves an unreported issue where the canvas and sidebar buttons were obscured at mobile breakpoints.
This is achieved by having the setVersion script be able to update the root package.json version number as well as all package.json files not in the samples directory.
With the root version set version.ts is updated with gulp
The storybook-pr workflow will set the version of the built packages based on either the branch name if the branch starts with next and would be published to npm as a preview version or by pr number.
PR checklist
yarn build) and changes have been tested in at least two supported browsers (Edge + non-Chromium based browser)yarn setLicense)Other information