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

developer-experience: deployment previews for pull requests #9276

Closed
1 task done
hydrosquall opened this issue Mar 3, 2024 · 6 comments
Closed
1 task done

developer-experience: deployment previews for pull requests #9276

hydrosquall opened this issue Mar 3, 2024 · 6 comments
Assignees
@hydrosquall
Labels
Enhancement 🎉

Comments

@hydrosquall
Copy link
Member

hydrosquall commented Mar 3, 2024 •
edited
Loading

Enhancement Description

Goal: Reduce time and effort to validate change requests, and improve review quality for vega-lite change requests (PRs). By making a deployment preview easy, it makes it easier to test end-user facing behaviors.

Motivating use-cases

Expected behavior

  • When a new PR is opened, build a copy of the vega-lite docs site and/or vega-editor that uses this branch's copy of vega-lite.
    • TBD which is easier to do first.

Checklist

  • I checked for duplicate issues. ( preview )

Notes

  • It's possible to set this up with a 3rd party provider (each with their own pricing model), but I'd like to first try if we can do this purely with Github actions.
@hydrosquall hydrosquall mentioned this issue Mar 3, 2024
Merged
@hydrosquall hydrosquall self-assigned this Mar 3, 2024
@hydrosquall hydrosquall mentioned this issue Mar 3, 2024
Closed
@hydrosquall hydrosquall linked a pull request Mar 3, 2024 that will close this issue
build: add deployment previews for vega-lite documentation site #9277
Closed
@hydrosquall hydrosquall mentioned this issue Mar 30, 2024
Merged
hydrosquall added a commit that referenced this issue Apr 6, 2024
@hydrosquall
build: Configure deployment previews with Vega Editor (#9294)
64d6daf 
## Motivation

- A cloudflare-based take on
#9276
- As discussed w/ @domoritz, Previewing the editor site is probably more
useful than the docs site, so we're going after that first

## Changes

- Use explicit packageManager version so Cloudflare doesn't autoupgrade
to yarn 3 (breaks lockfile)
- Add a build script (originally this was a 1-liner in package.json but
it was getting hard to read) that
  - Builds vega-lite
- Clones vega/editor and links the local vega-lite in place of the full
build
- Install `vega/editor` without running the `prepare` script. (The CI
device doesn't have rsync installed).
  - Makes empty index.json for vega / vega-lite examples.
- Build editor with vite with `/` as the base URL (previously it was
erroring due to thinking it was under the `/editor` subdomain).
Technically this is an abstraction leak but fixing it would involve
modifying the vega/editor repo too and I'd like to contain this change
to 1 repo if possible.

## Testing

- See Cloudflare comment below, confirm site loads

## Notes

- For now only `cameron.yick/*` branches have the previews since the
build script is WIP. It's using my personal Cloudflare account for
testing. I'll open it up to all (non dependabot/*) PRs this change is
confirmed.
- I've filed an request to
https://blog.cloudflare.com/cloudflare-new-oss-sponsorships-program to
see if we can get deployment previews sponsored (they also sponsor D3,
yarn). If not, I'll plan to discuss on Slack whether to keep Cloudflare
or switch the config to a different account.
- Free plan limits: 500 builds/ month:
https://developers.cloudflare.com/pages/platform/limits/ .
@hydrosquall
Copy link
Member Author

hydrosquall commented Apr 6, 2024 •
edited
Loading

Here's a copy of the setup on Cloudflare so anyone can configure this for their own account. ( Docs on preview deployments )

As discussed in #vega-maintainers , this only builds the vega/editor, not the docs .

image

  • Disable automatic deployments on main
  • Blocklist for branches: dependabot/* , docs/*
  • Keeplist for builds: the src/* directory
  • Build settings
    • run yarn run build-editor-preview
    • Output the result to /editor/dist

See the result here: https://vega-lite.pages.dev/#/

@domoritz
Copy link
Member

domoritz commented Apr 6, 2024

Sweet. I think we can close this now, right?

@hydrosquall
Copy link
Member Author

hydrosquall commented Apr 6, 2024 via email

@domoritz
Copy link
Member

domoritz commented Apr 6, 2024

That's not as critical as the editor imo but could also be useful. How about we close this for now until we learn a bit more about how the current setup works out?

@hydrosquall
Copy link
Member Author

hydrosquall commented Apr 7, 2024 via email

@domoritz domoritz closed this as completed Apr 7, 2024
@hydrosquall
Copy link
Member Author

Idea for future : if building previews per commit automatically eats through the builds too quickly much, we can use the "Deploy hooks" feature to trigger deploys via specialized comments (like /request-deploy), or having a microsite where people can request builds by entering the PR #.

@hydrosquall hydrosquall mentioned this issue May 19, 2024
Closed
@hydrosquall hydrosquall mentioned this issue May 31, 2024
Merged
hydrosquall added a commit that referenced this issue May 31, 2024
@hydrosquall
build: switch bundler for deploy previews back to parcel (#9362)
b3c69bb 
## Motivation

- Following vega/editor#1420,
#9276 stopped working
- This updates the build command for compatibility with parcel.

## Changes

- Updates stale comments
- Don't mention vite, try to stick to the yarn build command (with 1
parcel specific flag
parcel-bundler/parcel#206 (comment)
)

## Testing

- Check if deploy preview link loads correctly (
[src](https://cameron-yick-fix-deploy-prev.vega-lite.pages.dev/#/url/vega-lite/N4IgJAzgxgFgpgWwIYgFwhgF0wBwqgegIDc4BzJAOjIEtMYBXAI0poHsDp5kTykBaADZ04JAKyUAVhDYA7EABoQAEzjQATjRyZ289AEEABBBoIcguIaZJ1h2DcyGA7nRiHETOMtXLDypJhUiioBKKigxEiCDGpoANqgYSD6wUxoAEwAHAC+ColoIABCqWhiYrn56ADCJagALADMFSBJACK1AJwAjM1JAKK1mT15LQUAYrViTSNJAOK1XR29BQASgwDsy+gAkpPp2QC6uSDI6gDWBdbqwXCyUGzKNLJkaKAAHq8gAGY0cILKBRQSkwAE8cHACrI2AgnlFgkg3jQIJ9BEhPIJ9M8LGgAAzZY4gz4-P4A9BpYFgiHoACODCQsh0gR0pBA+OyQA)
)
@hydrosquall hydrosquall mentioned this issue Aug 6, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hydrosquall hydrosquall

Labels
Enhancement 🎉
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

build: add deployment previews for vega-lite documentation site vega/vega-lite
2 participants
@domoritz @hydrosquall