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

Delete the dist folder #324

Closed
jasonpaulos opened this issue Mar 24, 2021 · 0 comments · Fixed by #326
Closed

Delete the dist folder #324

jasonpaulos opened this issue Mar 24, 2021 · 0 comments · Fixed by #326
Assignees
Labels

Comments

@jasonpaulos
Copy link
Contributor

jasonpaulos commented Mar 24, 2021

Summary

The dist folder is getting pretty large, especially since the output of the TypeScript compilation process is being put there. The original reason for including this folder was to provide an easy way for users to download minified browser bundles. We should stop checking in this folder to the repo and address that issue in a better way.

Scope

The proposal is:

  • Delete the dist folder from the repo and put it in the .gitignore (and maybe also .dockerignore 🤔).
  • For each GitHub release we have, retroactively generate bundles (or steal from previous versions in the repo history) and upload them as release assets.
  • Update our readme to direct users toward the GH release page to download minified browser bundles.
  • Create a new file to document the publishing process. This should include:
    • The commands needed to fully populate the dist folder before publishing (i.e. how to generate bundles and types from source).
    • Directions about which files need to be uploaded to new GH releases. Future releases should use CDNs, so maybe we can include a link to a CDN in the GH release?

Urgency

This blocks #323.

@jdtzmn jdtzmn self-assigned this Mar 25, 2021
@jdtzmn jdtzmn mentioned this issue Mar 26, 2021
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants