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

Move sample files out of this repo #126

Open
KOLANICH opened this issue May 12, 2021 · 0 comments
Open

Move sample files out of this repo #126

KOLANICH opened this issue May 12, 2021 · 0 comments

Comments

@KOLANICH
Copy link

KOLANICH commented May 12, 2021

I guess the way we store sample files doesn't scale well.

  1. git is not very suitable for storing binary files.
  2. binary files will bloat these repo and application.
  3. it doesn't allow storing files in other places and updating them.

Requirements for the solution:

  • should not bloat the WebIDE repo
  • the files should be loaded lazily
  • should allow hosting actual files in the repos other than one single blessed repo
  • should not require lot of maintaince from our side

Proposal:

  1. store binary files in separate repos. If possible, not in our repos.
  2. create a YAML file with an array, easch item of which list sources, like this:
- uri: <direct uri to file sample. Must be available using CORS. Must be Wayback Machined before the addition>
- github: <a name of a GitHub repo>
  d-rx: <a regular expression dir path must satisfy>
  n-rx: <a regular expression file name (without rest of path) must satisfy>

Ideally the format will eventually be embedded into kst format, so the real-world samples to be used in automatic testing.

The file should be stored in a dedicated repo.

  1. CI script combines the sources, generating a file like this:
- uri: <direct uri>
- uri: <direct uri>
  name: <used to resolve naming conflicts>
  1. This list is used by the WebIDE to fetch the files. The WebIDE can even use the info from *.ksys' file-extension to suggest the samples to a user.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant