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

[Proposal] Remove dist folder and its content from git for the v4 #1270

Merged
merged 4 commits into from
Sep 22, 2023

Conversation

peaBerberian
Copy link
Collaborator

This is a proposal for something I wanted to do for a long time but didn't for legacy reasons.

Today builds, which are parts of the dist/ folder at the root of this repository, are stored and its update committed through git, alongside the rest of the code.

This means that people cloning or even just browsing the repo is going to be polutted by megabytes of uninteresting bundled code which can already be built on demand through our bundling dependencies (I hope deterministically? Or at least not different in ways that matters?).

Removing the dist folder completely would have the following pros, at least to me:

  • no need to store the bundle through git and its mostly uninteresting and large diffs, which may lead to a future gain in storage space, though I don't know what the proportions are (chances are they're very small, but still).

  • When using git tools or tools relying on files like .gitignore (e.g. the searching tool ripgrep - which I use daily. I think that VSCode also rely on it or at least it could last time I read about it - for the lost and sad people that are not on vim/neovim yet).

    Before, using those tools on the whole repo without explicitely discarding the dist directory would lead to a lot of polution, especially in search.

  • It un-clutters the repository. I like the idea of being able to understand its structure just by browsing it and one less directory is a nice step towards that goal.

Yet it has the following cons I can think of:

  • It removes the previous possibility of just looking at the build on github and copy-pasting the bundle's code. Which some did on very fast tests in the past.

  • It leads to the necessity of first bundling the rx-player before doing things like npm link/yarn link or other tools/scripts that I'm not thinking of right now.

  • We have to check if it doesn't break anything I did not think about

@peaBerberian peaBerberian added v4.0.0 Candidate PR/issue for a v4.0.0 release Priority: 3 (Low) This issue or PR has a low priority. labels Aug 22, 2023
@peaBerberian peaBerberian added this to the 4.0.0 milestone Aug 22, 2023
@peaBerberian peaBerberian force-pushed the misc/remove-compiled-builds-from-git branch from 8a5c871 to 1a262df Compare September 12, 2023 17:18
peaBerberian and others added 4 commits September 15, 2023 18:27
Add `trackInfo` property to some `MediaError`
Add `trackInfo` property to some `MediaError`
Add `trackInfo` property to some `MediaError`
This is a proposal for something I wanted to do for a long time but
didn't for legacy reasons.

Today builds, which are parts of the `dist/` folder at the root of this
repository, are stored and its update committed through git, alongside the
rest of the code.

This means that people cloning or even just browsing the repo is going
to be polutted by megabytes and megabytes of uninteresting bundled code
which can already be built on demand through our bundling dependencies
(I hope deterministically? Or at least not different in ways that
matters?).

Removing the dist folder completely would have the following pros, at
least to me:

  - no need to store the bundle through git and its mostly uninteresting
    and large diffs, which may lead to a future gain in storage space,
    though I don't know what the proportions are (chances are they're
    very small, but still).

  - When using git tools or tools relying on files like `.gitignore`
    (e.g. the searching tool ripgrep - which I use daily. I think that
    VSCode also rely on it or at least it could last time I read about
    it - for the lost and sad people that are not on vim/neovim yet).

    Before, using those tools on the whole repo without explicitely
    discarding the `dist` directory would lead to a lot of polution,
    especially in search.

  - It un-clutters the repository. I like the idea of being able to
    understand its structure just by browsing it and one less directory
    is a nice step towards that goal.

Yet it has the following cons I can think of:

  - It removes the previous possibility of just looking at the build on
    github and copy-pasting the bundle's code. Which some did on very
    fast tests in the past.

  - It leads to the necessity of first bundling the rx-player before
    doing things like `npm link`/`yarn link` or other tools/scripts that
    I'm not thinking of right now.
@peaBerberian peaBerberian force-pushed the misc/remove-compiled-builds-from-git branch from 1a262df to dd452c8 Compare September 15, 2023 16:28
@peaBerberian peaBerberian merged commit aa8f2da into next-v4 Sep 22, 2023
3 checks passed
peaBerberian added a commit that referenced this pull request Sep 22, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 27, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 27, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 27, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Sep 29, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
@peaBerberian peaBerberian modified the milestones: 4.0.0, 4.0.0-beta.3 Sep 29, 2023
peaBerberian added a commit that referenced this pull request Oct 13, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 13, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 13, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 13, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 13, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 13, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 19, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Oct 26, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
peaBerberian added a commit that referenced this pull request Nov 7, 2023
…rom-git

[Proposal] Remove dist folder and its content from git for the v4
@peaBerberian peaBerberian deleted the misc/remove-compiled-builds-from-git branch February 7, 2024 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: 3 (Low) This issue or PR has a low priority. v4.0.0 Candidate PR/issue for a v4.0.0 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant