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

CSS Library: update package.json for publishing #946

Merged
merged 3 commits into from
Nov 15, 2023

Conversation

it-harrison
Copy link
Contributor

@it-harrison it-harrison commented Nov 13, 2023

Chromatic

https://make-css-library-publishable--60f9b557105290003b387cd5.chromatic.com


Description

This PR makes the css-library package able to be published to npm so that it can be used as a dependency in the web-component package. There is a companion PR here, which updates web-components to use css-library to import the variables that are generated in css-library (and therefore ends the need to copy the file manually to web-components).

Testing done

local testing

Screenshots

Acceptance criteria

  • [ ]

Definition of done

  • Documentation has been updated, if applicable
  • A link has been provided to the originating GitHub issue (or connected to it via ZenHub)

Copy link
Contributor

@rmessina1010 rmessina1010 left a comment

Choose a reason for hiding this comment

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

LGTM

@jamigibbs
Copy link
Contributor

Do we want this added to the component library release notes? If not then this PR should be tagged as ignore-for-release

@it-harrison it-harrison merged commit 981e742 into main Nov 15, 2023
6 checks passed
@it-harrison it-harrison deleted the make-css-library-publishable branch November 15, 2023 14:35
@jamigibbs
Copy link
Contributor

@it-harrison I saw this was merged but I'm still not clear if we want this PR to be a part of the release notes for the component-library #946 (comment)

I know that we intend for this package to have its own independent release notes but that has not been set up yet. Won't labeling this PR as major lump it into the web component releases?

@@ -1,9 +1,10 @@
{
"name": "@department-of-veterans-affairs/css-library",
"private": true,
"version": "0.0.1",
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be an issue to start at this version number because version 0.1.0 already exists and if/when we ever make a minor version update to the package, we will not be able to publish it as 0.1.0.

https://www.npmjs.com/package/@department-of-veterans-affairs/css-library?activeTab=versions

cc @micahchiang

Copy link
Contributor

Choose a reason for hiding this comment

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

hmm that's a good point. Tbh, I was the one that told @it-harrison it'd probably be okay to start at 0.0.1, so that's my bad. I think given the life cycle stage css library is in, it's probably not too big of a deal to eventually just skip over 0.1.0, unless folks feel strongly about that.

Copy link
Contributor

Choose a reason for hiding this comment

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

No big deal. Someone might just be a little confused for minute. If we're following Semantic Versioning, the most important release will be 1.0.0 anyway which should signal it's ready for the public.

  • (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

  • Version 1.0.0 defines the public API.

@jamigibbs jamigibbs changed the title update package.json for publishing CSS Library: update package.json for publishing Nov 15, 2023
@jamigibbs jamigibbs added minor For a minor Semantic Version change and removed major Major change in semantic versioning labels Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor For a minor Semantic Version change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants