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

Should we move to a src and dist directory structure? #59

Closed
praveenpuglia opened this issue Dec 9, 2015 · 35 comments
Closed

Should we move to a src and dist directory structure? #59

praveenpuglia opened this issue Dec 9, 2015 · 35 comments

Comments

@praveenpuglia
Copy link
Contributor

It's not high priority but right now even changing the gulp file triggers the watch. It would probably be better to move the src in src directory and generated files in dist directory?

@kurtextrem
Copy link
Contributor

👍

@kurtextrem
Copy link
Contributor

Maybe also auto generating the shy version is a good idea as well.

@shshaw
Copy link

shshaw commented Dec 9, 2015

As someone trying to parse the bliss code for the first time, src and dist dirs would be quite helpful!

@zdfs
Copy link
Collaborator

zdfs commented Dec 9, 2015

@LeaVerou What do you think about this. I was also wondering if we should separate the actual code development to a master branch, leaving the gh-pages branch for the docs. Might make it easier to tag releases.

@guoguo12
Copy link
Collaborator

guoguo12 commented Dec 9, 2015

I'm a fan of both src/dist and master/gh-pages. Or, at the very least, we should move index.js and transform.js into a subdirectory, just to make it clear those aren't part of the actual library.

@praveenpuglia
Copy link
Contributor Author

👍 both @zdfs & @guoguo12

@LeaVerou
Copy link
Owner

LeaVerou commented Dec 9, 2015

I have this issue with most of my projects, so I would definitely welcome a solution :(
The problem is, I want to have access to the current builds on gh-pages (e.g. for downloads or for the actual site), but without having to duplicate them. Any ideas? AFAIK git submodules don't work for branches, just directories…

👍 to @guoguo12, yes, if we keep everything in the same dir, moving the website js files to a folder is probably a good idea.

@kurtextrem Not sure what you mean. bliss.shy.js is the source, bliss.js is auto-generated.

@zdfs
Copy link
Collaborator

zdfs commented Dec 9, 2015

Could just have the source in master and then when we release, pull it in to gh-pages via npm and do a gulp task for copying the files somewhere for downloading?

@praveenpuglia
Copy link
Contributor Author

@LeaVerou can we not have the download links point to the raw.github... of the generated files on master?

@LeaVerou
Copy link
Owner

LeaVerou commented Dec 9, 2015

@zdfs Then it's yet another manual step, that I'd rather avoid. Also, I'd rather have the current version on the website, not the last "release".
@praveenpuglia I think that’s generally discouraged, no? Also, one more DNS lookup.

@zdfs
Copy link
Collaborator

zdfs commented Dec 9, 2015

Ok. So let's define what we have so far.

  1. There's been a request for tagged releases on Github.
  2. There's been a request for src and dist folders in the project.
  3. Lea would like the latest version for download at any time.
  4. How are we updating NPM right now?
  5. Move website JS files to separate directory?

@praveenpuglia
Copy link
Contributor Author

@LeaVerou curious why that's discouraged. Anything other than DNS lookup issue?

@guoguo12
Copy link
Collaborator

guoguo12 commented Dec 9, 2015

I think that sums it up. I also suggested moving the website JS files into a separate subdirectory, but that can be addressed later.

@zdfs: Updated.

@LeaVerou
Copy link
Owner

LeaVerou commented Dec 9, 2015

Should I wait until we decide on this before I start tagging releases?

@zdfs
Copy link
Collaborator

zdfs commented Dec 9, 2015

@LeaVerou - We can start tagging, that won't get in the way of anything. I'm just attempting to try and find a holistic solution we can all execute on.

@zdfs
Copy link
Collaborator

zdfs commented Dec 9, 2015

I think we have most of our criteria.

  1. There's been a request for tagged releases on Github and NPM.
  2. There's been a request for src and dist folders in the project.
  3. Lea would like the latest version for download at any time.
  4. Move website JS files to separate directory?

Ideas. Suggestions. The floor is open.

@LeaVerou
Copy link
Owner

LeaVerou commented Dec 9, 2015

Isn't 4 tied to 1? If releases are being tagged, I can just npm publish, no?

@zdfs: Updated.

@dperrymorrow
Copy link
Collaborator

you could link to the latest version on master from the gh-pages branch.
You simply link to the raw file on github on the master branch.
for example: https://raw.githubusercontent.com/LeaVerou/bliss/gh-pages/bliss.shy.min.js

that way gh-pages could simply be the docs website as one would expect.

@shshaw
Copy link

shshaw commented Dec 9, 2015

You may need to use a service like RawGit in order to have the script run on the page. GitHub does not return the right headers when embedding a script from the raw URL, but RawGit gets around that.

@LeaVerou
Copy link
Owner

LeaVerou commented Dec 9, 2015

Relying on a third party service like rawgit makes me a bit uneasy.
Is there a way (maybe a post commit hook?) to copy files from master to gh-pages without any extra manual steps?

@zdfs
Copy link
Collaborator

zdfs commented Dec 10, 2015

@LeaVerou - Domenic has something like this: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd

@guoguo12
Copy link
Collaborator

Any consensus on this? @zdfs: I like the Domenic script provided that it can be set up easily.

@dperrymorrow
Copy link
Collaborator

@guoguo12 there is also talk of an html page on the site with tests running so that could complicate this issue #71

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

There are things we can try, but no work has started. I guess we could make a master from gh-pages and see how far we get with the build to see if we can satisfy all the use cases, moving everyone to master if we're successful. Any volunteers?

@praveenpuglia
Copy link
Contributor Author

I am here!

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

Ok. Just so we can make some progress on this story. I'm going to branch gh-pages to master. @praveenpuglia, am I correct in assuming you'd like to give it a shot. You up to date on this thread? Know all the use cases we want to solve?

@wcastand
Copy link
Contributor

i'm available too for testing or helping :)

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

Ok. Branch is made.

@praveenpuglia
Copy link
Contributor Author

@zdfs - Yep. But if I do something stupid, you would know! :) I have cloned the branch and pushed it to mine now. Should I go ahead and make those directory and gulp changes?

@wcastand
Copy link
Contributor

do we need to make a slack or something.
That could help organize et don't make the same thing twice no ?

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

I can do that.

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

I made a Slack instance at https://blissjs.slack.com/.

@praveenpuglia
Copy link
Contributor Author

Says I am not in that team. This email - [email protected] ?

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

I'll take a look and send out invites.

@zdfs
Copy link
Collaborator

zdfs commented Dec 11, 2015

Closing this for #82.

@zdfs zdfs closed this as completed Dec 11, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants