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

CI / dev experience remaining issues #28

Open
1 of 7 tasks
Firenze11 opened this issue Sep 12, 2019 · 5 comments
Open
1 of 7 tasks

CI / dev experience remaining issues #28

Firenze11 opened this issue Sep 12, 2019 · 5 comments
Labels
dev exp Development experience help wanted Extra attention is needed

Comments

@Firenze11
Copy link

Firenze11 commented Sep 12, 2019

  • add readme to npm homepage https://www.npmjs.com/package/@mlvis/manifold
  • add publishing script to Travis CI
  • auto bump version in the main package.json (currently ocular-publish only bumps versions in modules package.json
  • install storybook for development purpose
  • properly structure published module (below is the current structure, which causes import Manifold from '@mlvis/manifold' to not work Publish #27
    image
  • add depcheck
  • use gh-pages module to deploy website
@kenns29
Copy link
Contributor

kenns29 commented Sep 13, 2019

auto bump version in the main package.json (currently ocular-publish only bumps versions in modules package.json

lerna bump typically only bumps modules in the workspace. Since example/ and website/ are not in the workspace (and supposedly not), it is not necessary for "bump" to work for them.

@Firenze11
Copy link
Author

lerna bump typically only bumps modules in the workspace. Since example/ and website/ are not in the workspace (and supposedly not), it is not necessary for "bump" to work for them.

But that will create confusion. Imagine someone new will have to go to modules subdirectories to find out what current version is.

This was referenced Sep 13, 2019
@ibgreen
Copy link

ibgreen commented Sep 13, 2019

Not sure if this is a relevant comment, but I prefer using synchronized versioning of submodules. I.e. all modules get published with the same version even if only some have changed. That version is then in lerna.json in the root.

@Firenze11
Copy link
Author

Not sure if this is a relevant comment, but I prefer using synchronized versioning of submodules. I.e. all modules get published with the same version even if only some have changed. That version is then in lerna.json in the root.

We are already doing that

@kenns29
Copy link
Contributor

kenns29 commented Sep 14, 2019

I changed my mind and I think aligning the versions on website/ and example/ is actually a good idea, because we will have a documentation website later on and the documentation version should align with the module versions, so should be the demo in or referenced by the documentation.

To do so you can make some scripts following the lerna bump to copy over the version number from the modules to the docs/websites.

@Firenze11 Firenze11 added the dev exp Development experience label Sep 16, 2019
@Firenze11 Firenze11 mentioned this issue Oct 31, 2019
4 tasks
@Firenze11 Firenze11 added the help wanted Extra attention is needed label Feb 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev exp Development experience help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants