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

chore: enrich package.json #298

Merged
merged 1 commit into from
Jan 7, 2025
Merged

chore: enrich package.json #298

merged 1 commit into from
Jan 7, 2025

Conversation

kentbull
Copy link
Collaborator

Bump version to 0.3.0-dev0 (latest code from today's main branch) and enrich the package.json with useful package metadata to support discovery via NPM.

@kentbull kentbull requested review from 2byrds and lenkan December 18, 2024 20:56
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.63%. Comparing base (f368351) to head (941a7e2).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #298   +/-   ##
=======================================
  Coverage   83.63%   83.63%           
=======================================
  Files          48       48           
  Lines        4235     4235           
  Branches     1055     1055           
=======================================
  Hits         3542     3542           
  Misses        663      663           
  Partials       30       30           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@2byrds 2byrds left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Collaborator

@lenkan lenkan left a comment

Choose a reason for hiding this comment

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

If we want to do this, can you run npm install locally on your machine to ensure package-lock.json is updated with the new version?

Otherwise, the idea was that the version field on the main branch is the next minor/major version. Then you publish pre-releases from that by temporarily doing an in place edit in package.json before npm publish. That way, you can implement a workflow that publishes a pre-release on every commit to main, and every git tag. To elaborate:

  • version: 0.3.0 on package.json on main.
  • Commit with sha abc123 is pushed to main.
  • Workflow triggers and publishes 0.3.0-abc123 to npm
  • Commit with sha zyx123 is pushed to main.
  • Workflow triggers and publishes 0.3.0-xyz123 to npm
  • Repeat n number of times
  • Maintainer decides to publish a beta tag:
    • Create git tag 0.3.0-dev.1
    • This triggers the workflow that publishes 0.3.0-dev.1 to npm
  • Maintainer decides to publish 0.3.0:
    • Create git tag 0.3.0
    • This triggers the workflow that publishes 0.3.0 to npm
    • Create new commit on main that changes version: 0.4.0.
    • Any bug fixes to 0.3.x can be branched of from the 0.3.0 tag.

@lenkan
Copy link
Collaborator

lenkan commented Dec 19, 2024

I did some work on this before: #260 (comment)

However, the current NPM_DEPLOY_SECRET does not have sufficient rights to publish. I also have a simplified version of the workflow that allows you to do the same thing locally, but I never finished that work. If we can get a new working deploy secret, either for signify-ts or @weboftrust/signify package, I can pick it up again over the weekend.

@kentbull kentbull force-pushed the version-bump-0-3-0-dev0 branch from 30f9bcf to 8ff1376 Compare December 19, 2024 13:17
@kentbull kentbull force-pushed the version-bump-0-3-0-dev0 branch from 8ff1376 to 941a7e2 Compare December 19, 2024 13:17
@lenkan lenkan changed the title chore: bump to v0.3.0-dev0 and enrich package.json chore: enrich package.json Jan 7, 2025
@lenkan lenkan merged commit 332a46b into main Jan 7, 2025
8 checks passed
@kentbull kentbull deleted the version-bump-0-3-0-dev0 branch January 14, 2025 22:58
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.

3 participants