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

Codebase UI local deployment #1880

Closed
3 tasks done
pchiusano opened this issue Apr 21, 2021 · 0 comments
Closed
3 tasks done

Codebase UI local deployment #1880

pchiusano opened this issue Apr 21, 2021 · 0 comments

Comments

@pchiusano
Copy link
Member

pchiusano commented Apr 21, 2021

Discussed with @stew @hojberg and @runarorama how UCM releases will embed the codebase UI. I think this writeup accurately captures the decisions from that, but pipe up if not.

Here's the UX:

The UX is: User starts up UCM which provides a URL to visit. User visits that URL and gets the codebase UI. (Later we might have an electron app which bundles the codebase UI and UCM, however that's out of scope for now.)

Nice touch: the startup message should also say how to find that URL if the user forgets it. Like maybe help ui shows the URL as well.

Here's the plan:

  • @runarorama will change the codebase server to serve the API at <token>/api and the <token>/ui. The /ui endpoint will look for a file /ui/index.html by default or will serve whatever file is specified via a --ui=/path/to/dev-ui/index.html flag and/or environment variable. If no such file exists, it will 404 as normal.
  • @hojberg will get CI for the codebase-ui project to produce GitHub releases containing the HTML+JS for the built codebase UI. @stew to support this.
  • @stew will create a third project, maybe ucm-release, which will pull any two named versions of Unison and the codebase UI from GitHub releases and package them up into a release.

For later, @stew or someone else could work on doing daily or weekly releases, but I don't think that is MDP for M2. You can tag releases as 'daily' and then they don't show up in the main releases page, see for instance this example

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants