313 - Release design system npm package version 1.1.0 #341
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.
What this PR does / why we need it:
This PR updates the package.json of the design system with the new version 1.1.0. @iqss/dataverse-design-system
Also I added some instructions to the README on how to publish a new version.
A part from that I added a preset to lerna so the CHANGELOG.md is automatically updated with the new commits since the last version. See Conventional Commits for commit guidelines.
Which issue(s) this PR closes:
Special notes for your reviewer:
The automation of the publishing will be developed in this other issue:
The creation of a test registry will be developed in this other issue:
Suggestions on how to test this:
To test the package:
npx create-next-app
in your machine (ensure you have node installed in your machine)npm i
to install all the packages of the demo appnpx create-next-app
then go to thesrc/app/page.tsx
fileimport { Col, Container, Form, Row} from "@iqss/dataverse-design-system";
. If you are using next-js you'll need to set'use client'
at the top of the file since the design system components are client componentssrc/app/page.tsx
filenpm run dev
and go to http://localhost:3000 to see the application using the design system componentsDoes this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Published version 1.1.0 of the Dataverse Design System to the npm registry @iqss/dataverse-design-system
Additional documentation:
Lerna publishing