Gulp: Gulp 4 Docs

[demisx]

We currently use gulp 3 for all our build needs. I'd like to come up to speed on gulp 4 and potentially move some of our projects to it. I have a couple of questions:

1. When is the anticipated release for v4?
2. What's the best place to start reading about v4? I am not sure if docs on 4.0 branch are up to date.

Thanks.

[RnbWd]

See milestones

[demisx]

@RnbWd Thanks. I saw that, but wasn't sure that was accurate. Are there any up-to-date docs on 4.0 yet?

[johnpapa]

I'm interested in contributing to this. I'll be releasing a 4+ hour video series in Gulp in late Jan 2015 and would like to help write the v4 docs, migration and more recipes for v4 when its time

[travm]

I'll be available to help as well.

[phated]

Some places to start:

https://github.com/phated/async-done
https://github.com/phated/undertaker
https://github.com/phated/bach
and the vinyl-* repositories

These docs will need to be translated to gulp-specific docs since gulp4 is built on top of them.

[contra]

Yeah, we need help updating the docs folder which has become quite the large task. I'm open to seriously trimming down the docs folder to the essentials, reorganizing, redoing entirely, etc. for the gulp release. I will be doing markdown -> html and adding some nice styles to put the docs on the main site. One thing we failed really bad at was putting all the docs in one place (there are so many sub-projects) which I want to address in the 4.0 release.

[sashasochka]

Any updates on the dates? Gulp 4.1 according to milestone page should have been released but 4.0 is not released yet.

[contra]

@sochka Milestone dates mean nothing, we are busy people - it will get released when it gets released. Use the 4.0 branch until then.

[phated]

I do actually have an update. @dinoboff has been knocking out quite a few of the remaining blockers and I am using 4.0 in my current project to see if I run into any major bugs. That being said, @contra is right, it will be released when it is ready. The best thing you can do is use the 4.0 branch and let us know of any problems.

[contra]

Also of relevance to this issue: We are working on a new website that will put all of the docs, blogs, guides, tutorials, recipes, etc. from all of the repos across the gulp ecosystem (vinyl, vinyl-fs, glob-watcher, etc.) in one place. The site will be searchable, indexed on google, and pretty badass.

[callumacrae]

yay! :smiley:

[contra]

If anybody would like to be a part of writing the docs/blogs/guides/whatever for the new site (there is a nice editor page and everything) send an email to [email protected] and I'll get you invited as an admin

[phated]

I've begun migrating docs to the new website, but I don't have much time to do it. Please, if you have availability to do this, email @contra

[torarnek]

I am looking very much forward to running tasks in parallell. Is it possible to get some kind of alpha release? That would help us starting using it. :)

[dinoboff]

npm install gulpjs/gulp.git#4.0

or if you want more control, fork it, and install your fork instead. E.g.:

npm install torarnek/gulp.git#4.0

[phated]

@dinoboff don't suggest the hash because we rebase 4.0 pretty often.

[demisx]

@torarnek I've documented Gulp 4 installation instructions here http://demisx.github.io/gulp4/2015/01/15/install-gulp4.html. So far, Gulp 4 has been working great for us and it's been as stable as any production version. Highly recommend.

[dinoboff]

@phated fixed :)

[torarnek]

@demisx @dinoboff Thanks, however, in our production builds we are not allowed to link directly to github, it has to be released on NPM so that the packages can be cached in our build environment.

Would it be possible go have an alpha/beta release on npm? :)

[phated]

@torarnek sorry, we aren't even close to an npm release.

[deepsweet]

but why it can't be published as alpha version(s)?

[callumacrae]

Because you typically don't publish alpha releases until you've at least finished all your features. As you can install from github, there is also no need for development releases.

You're expecting the developers to put in extra for work for absolutely no gain for them—time they could spend working on Gulp 4 itself.

Just install from github. You shouldn't be running dev code on production anyway, so there shouldn't be any restrictions on where you can install from.

[troch]

@contra, @phated I have recently started a series of articles that is a tour of main Node-based building tools: Grunt, Gulp and Broccoli (and will probably talk about other solutions like metalsmith). The Gulp part made me dig quite a bit because of Gulp 4 and I have came up with 4 articles, plus a "how to install" and a new gulp plugin for incremental builds called gulp-memory-cache:

• How to install Gulp 4
• Part 1: examples
• Part 2: Gulp's anatomy
• Part 3: writing transformers
• Part 4: incremental builds

There is a mix of Gulp 3 and 4: Parts 1, 2 and 3 talk about both and Part 4 focuses on Gulp 4. For that reason I don't think articles can be reused as-is but if you are interested in any of the above, I am happy to contribute or for anyone to reuse. English is not my native language so my grammar and syntax are not up there, that's the only limitation :-)

[phated]

I believe the gulp4 docs are very good now. Also, we can open individual issues for anything we feel is missing. Going to close this.

[xtianus79]

Where are the docs located?

[xtianus79]

I found this and the fix at the bottom might have been the fix... http://blog.reactandbethankful.com/posts/2015/05/01/how-to-install-gulp-4/

[sameeri]

@xtianus79 and anyone who has difficulty looking for docs (gulp 4) right now and you have hit this issue looking around.

• https://github.com/gulpjs/gulp/blob/4.0/docs/API.md
• https://github.com/gulpjs/gulp-cli/tree/4.0/docs

Also, please look at the issues labeled documentation combined together with gulp 4 to understand the team's plan for docs.

• https://github.com/gulpjs/gulp/labels/documentation

Also, something cool to know : gulp 4 docs will be on gitbook, according to the team's plans.

[EricBou]

Actually I have some problem to use gulp v4.0 on github(firewall and security problem)

Someone planning to make gulp version 4.x available on NPM registry soon?