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

Include dist files #16

Closed
XhmikosR opened this issue Jan 17, 2017 · 17 comments
Closed

Include dist files #16

XhmikosR opened this issue Jan 17, 2017 · 17 comments

Comments

@XhmikosR
Copy link

It seems currently the dist files aren't in the repo nor in the release zip.

Can you include them in the next release?

@dotproto
Copy link
Contributor

I totally agree that built assets should be included in the release zip. As for in the repo, are there many other projects that include the built assets in the repository? That feels like an anti-pattern to me, but I'm just one random developer 😄

@XhmikosR
Copy link
Author

It's a personal preference regarding the repo :)

Any or both of the solutions would be much better than nothing :P

@developit
Copy link
Owner

I never include dist files in Git. I don't mind trying to force-add them for the tags, as long as it's not too much work. This is an npm module, so you can always access them using npm's tarball URL (seen here) or unpkg.com/mitt/.

@XhmikosR
Copy link
Author

Hmm, the reason I brought this up is https://github.com/developit/mitt/releases

Sure, I can have it as a dep, but this could be handy too.

@developit
Copy link
Owner

Agreed! I think I can force-add them in the release script.

@XhmikosR
Copy link
Author

Is that even possible? To have the dist files in tag.

@developit
Copy link
Owner

not in a nice way

@XhmikosR
Copy link
Author

So the only solution is committing the dist files and updating them with every release. Personally, I'm not aware of another solution.

@developit
Copy link
Owner

Ah, if that's the only way then I don't think it's worth it. Just like I don't publish anything to bower, I don't really want people relying on Github to install things.

@raed667
Copy link

raed667 commented Jan 17, 2017

A dist folder would make life a lot easier for many people.

@developit
Copy link
Owner

Do you have a concrete use-case I can understand?

@raed667
Copy link

raed667 commented Jan 17, 2017

A developer comes across the repository and wants to test the library without having to install 42MB of dependencies ?

@developit
Copy link
Owner

Installing this library doesn't require any other dependencies. There are only devDependencies, which are not installed when running npm install mitt. The entire source is already in the npm package, you can see it here: https://unpkg.com/mitt/

@developit
Copy link
Owner

Perhaps we could skirt around having to commit dist/ to git by simply linking to the unpkg.com release in each tag/release?

@wooorm
Copy link

wooorm commented Jan 17, 2017

👋

I use Travis to publish distribution builds to GH releases (and also to publish to npm), which looks, for example, like this. Maybe that’s something you’d want to have?

@sospedra
Copy link

Mayber add the project to jsdelivr? https://github.com/jsdelivr/jsdelivr/blob/master/CONTRIBUTING.md

@developit
Copy link
Owner

developit commented Jan 18, 2017

I'm fine if someone wants to, though I'm actually not sure how useful it would be to load this library over a CDN. It's not a UMD module by default (though there is a .umd.js version in dist/..) so loading it via requirejs or similar would be quite painful. For me, I see no difference between referencing unpkg.com/mitt / unpkg.com/mitt/dist/mitt.umd.js or JSDelivr's URL, except that unpkg.com is completely automated on top of npm (requires no extra work, respects semver).

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

6 participants