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

313 - Release design system npm package version 1.1.0 #341

Merged

Conversation

MellyGray
Copy link
Contributor

@MellyGray MellyGray commented Mar 12, 2024

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:

  1. Create a new React application. I'll go with the first option which is running npx create-next-app in your machine (ensure you have node installed in your machine)
  2. In your app root folder run npm i to install all the packages of the demo app
  3. Follow the instructions from the README of the package @iqss/dataverse-design-system
  4. If you're using npx create-next-app then go to the src/app/page.tsx file
  5. Place the imports at the top of the file with the other imports import { 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 components
  6. Now copy the example code in the usage section of the package README and paste it somewhere inside the Home function of the src/app/page.tsx file
  7. Run the application using npm run dev and go to http://localhost:3000 to see the application using the design system components

Does 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

@MellyGray MellyGray linked an issue Mar 12, 2024 that may be closed by this pull request
@MellyGray MellyGray marked this pull request as ready for review March 12, 2024 17:23
@MellyGray MellyGray added Size: 3 A percentage of a sprint. 2.1 hours. pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows labels Mar 12, 2024
@coveralls
Copy link

Coverage Status

coverage: 97.179%. remained the same
when pulling 0552e73 on 313-release-design-system-npm-package-version-120
into 0e90218 on develop.

@g-saracca g-saracca self-assigned this Mar 13, 2024
Copy link
Contributor

@g-saracca g-saracca left a comment

Choose a reason for hiding this comment

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

LGTM!

@g-saracca g-saracca removed their assignment Mar 13, 2024
@ekraffmiller ekraffmiller self-assigned this Mar 15, 2024
@ekraffmiller
Copy link
Contributor

looks good!

@ekraffmiller ekraffmiller merged commit 509d4ee into develop Mar 15, 2024
12 of 14 checks passed
@MellyGray MellyGray deleted the 313-release-design-system-npm-package-version-120 branch March 18, 2024 17:55
jayanthkomarraju pushed a commit to jayanthkomarraju/dataverse-frontend that referenced this pull request May 31, 2024
…ackage-version-120

313 - Release design system npm package version 1.1.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 3 A percentage of a sprint. 2.1 hours.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Release design system npm package version 1.2.0
4 participants