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.

Sign up for GitHub

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

Jump to bottom

Put web viewer on npm #4003

Merged
merged 39 commits into from Nov 3, 2023
Merged

Put web viewer on npm #4003

merged 39 commits into from Nov 3, 2023

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Oct 25, 2023 •
edited by github-actions bot

What

Closes #3983

  • Create the package
  • Examples using the package
    • No framework
    • React
  • Document the package
    • Note about package version being equal to the rerun version (@rerun-io/web-viewer@0.9.1 can load the same files as pip install rerun-sdk==0.9.1)
    • Note about WASM imports
      • Bundlers generally handle WASM imports well
  • Build the package on CI
  • Add npm publish step to release process

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@jprochazk jprochazk added 🕸️ web regarding running the viewer in a browser include in changelog labels Oct 25, 2023
@jprochazk
update readme
8353226
@jprochazk
publish .d.ts files for the viewer js/wasm
a29d1b3
@jprochazk
ellipsis
bc78dee
@jprochazk
WASM -> Wasm
bf905e9
@jprochazk
Merge branch 'main' into jan/npm-web-viewer
a291e4c
@jprochazk
Merge branch 'main' into jan/npm-web-viewer
b3e5cb5
@jprochazk
update readme
bc3e49a
@jprochazk
add react module
167dc06
@jprochazk
add versioning script
c0ad49b
@jprochazk
bump versions
94d6da7
@jprochazk
add publish script + move into scripts directory
9f1e85d
@jprochazk
append to parent element
466481b
@jprochazk
bump versions
0cf8a2f
@jprochazk
Merge branch 'main' into jan/npm-web-viewer
10366a6
@jprochazk
add :debug build script
ecfc2e8
@jprochazk
Merge branch 'main' into jan/npm-web-viewer
dcf329f
@jprochazk
put packages in a common dir
a9be091
@jprochazk
build on PR
f08e132
@jprochazk
fix versioning script
e07079e
@jprochazk
bump to 0.11.0-alpha.1+dev
a9c455e
@jprochazk
manually bump versions to preserve build metadata
74b7783
@jprochazk
build on node 20
17daeb8
@jprochazk
add npm publish workflow
76bd144
@jprochazk
update npm versions in release
100d99a
@jprochazk
note about version lockstep
e3e134b
@jprochazk
add dependencies to publish-npm job + comment artifacts
6a7da29
@jprochazk jprochazk marked this pull request as ready for review November 2, 2023 12:43
@teh-cmc teh-cmc self-requested a review November 3, 2023 07:39
teh-cmc
teh-cmc approved these changes Nov 3, 2023
View reviewed changes
Copy link
Member

@teh-cmc teh-cmc left a comment

Choose a reason for hiding this comment

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

Looks good. Don't see much point in arguing over details when bootstrapping something of this size.

What's this "version": "0.0.8-alpha.2" though? That doesn't correspond to anything...

rerun_js/web-viewer/README.md Outdated Show resolved Hide resolved
rerun_js/web-viewer/react/README.md Outdated Show resolved Hide resolved
rerun_js/web-viewer/react/package.json
@@ -0,0 +1,41 @@
{
"name": "@rerun-io/web-viewer-react",
"version": "0.0.8-alpha.2",
Copy link
Member

Choose a reason for hiding this comment

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

What's this version? Is the react viewer not using the same version as everything else?

Copy link
Member Author

Choose a reason for hiding this comment

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

We haven't really "released" this yet, so this is a placeholder version

rerun_js/web-viewer/package.json
@@ -0,0 +1,45 @@
{
"name": "@rerun-io/web-viewer",
"version": "0.0.8-alpha.2",
Copy link
Member

Choose a reason for hiding this comment

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

Same here, what's 0.0.8-alpha.2 🤔

@jprochazk jprochazk merged commit 72a3753 into main Nov 3, 2023
37 checks passed
@jprochazk jprochazk deleted the jan/npm-web-viewer branch November 3, 2023 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@teh-cmc teh-cmc teh-cmc approved these changes

Assignees
No one assigned
Labels
include in changelog 🕸️ web regarding running the viewer in a browser
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Put web viewer on npm
2 participants
@jprochazk @teh-cmc