Disable incremental regeneration by default in Jekyll 3.0 #4059

Merged
merged 3 commits into from Oct 26, 2015

Conversation

Projects
None yet
5 participants
@alfredxing
Member

alfredxing commented Oct 26, 2015

Disable the feature as it's still not 100% working 100% of the time. Incremental regeneration can be re-enabled by specifying full_rebuild: false in the configuration.

(As per discussion in #4057)

Disable incremental regeneration by default in Jekyll 3.0
Disable the feature as it's still not 100% working 100% of the time. Feature
can be re-enabled by specifying `full_rebuild: false` in the configuration

@alfredxing alfredxing added this to the 3.0 milestone Oct 26, 2015

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

Need to update --full-rebuild tag to something like --incremental or --incr.

Member

parkr commented Oct 26, 2015

Need to update --full-rebuild tag to something like --incremental or --incr.

@parkr parkr added the needs-work label Oct 26, 2015

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

Is there any documentation on this feature? Perhaps it can say it's off by default.

Member

parkr commented Oct 26, 2015

Is there any documentation on this feature? Perhaps it can say it's off by default.

@alfredxing

This comment has been minimized.

Show comment
Hide comment
@alfredxing

alfredxing Oct 26, 2015

Member

On it!

There's barely any documentation, though it prints out whether it's enabled when building:

Configuration file: /Users/alfred/git/jekyll/test/_config.yml
            Source: /Users/alfred/git/jekyll/test
       Destination: /Users/alfred/git/jekyll/test/_site
 Incremental build: disabled
      Generating...
Member

alfredxing commented Oct 26, 2015

On it!

There's barely any documentation, though it prints out whether it's enabled when building:

Configuration file: /Users/alfred/git/jekyll/test/_config.yml
            Source: /Users/alfred/git/jekyll/test
       Destination: /Users/alfred/git/jekyll/test/_site
 Incremental build: disabled
      Generating...
@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

Incremental build: disabled

Maybe we should change this to say disabled. Enable with --incremental? or whatever flag you decide on

Member

parkr commented Oct 26, 2015

Incremental build: disabled

Maybe we should change this to say disabled. Enable with --incremental? or whatever flag you decide on

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@jaybe-jekyll

This comment has been minimized.

Show comment
Hide comment
@jaybe-jekyll

jaybe-jekyll Oct 26, 2015

Member

I prefer a switch/command/trigger to enable regeneration in general regardless of current state.

Building, Serving, Regenerating... all specific and chosen capabilities.

I would expect jekyll build to build once and return successful.

I would expect to jekyll build ---watch or jekyll build -w to enable/turn on regeneration.

$.02 💸

Member

jaybe-jekyll commented Oct 26, 2015

I prefer a switch/command/trigger to enable regeneration in general regardless of current state.

Building, Serving, Regenerating... all specific and chosen capabilities.

I would expect jekyll build to build once and return successful.

I would expect to jekyll build ---watch or jekyll build -w to enable/turn on regeneration.

$.02 💸

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Oct 26, 2015

Contributor

@jaybe-jekyll that very well could be the case when it's enabled by default but with it being disabled by default as an experimental feature now, that won't work.

Contributor

envygeeks commented Oct 26, 2015

@jaybe-jekyll that very well could be the case when it's enabled by default but with it being disabled by default as an experimental feature now, that won't work.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

@jaybe-jekyll It's still very experimental, but that's a fantastic idea for the future! :) Especially because -w is on by default for jekyll serve.

Member

parkr commented Oct 26, 2015

@jaybe-jekyll It's still very experimental, but that's a fantastic idea for the future! :) Especially because -w is on by default for jekyll serve.

@alfredxing

This comment has been minimized.

Show comment
Hide comment
@alfredxing

alfredxing Oct 26, 2015

Member

Agreed! Commits coming as soon as the tests pass. It'll be incremental in configuration and --incremental or -ir as command-line flags.

Member

alfredxing commented Oct 26, 2015

Agreed! Commits coming as soon as the tests pass. It'll be incremental in configuration and --incremental or -ir as command-line flags.

@jaybe-jekyll

This comment has been minimized.

Show comment
Hide comment
@jaybe-jekyll

jaybe-jekyll Oct 26, 2015

Member

I need to correct myself; apologies --

I prefer a switch/command/trigger required to enable regeneration,

Building, Serving, Regenerating... all specific and chosen capabilities.

I would expect jekyll build to build once and end, returning as successful.

I would expect to jekyll build --regnerateto enable/turn on regeneration, with or without --watch, as --regeneration would presume --watch.

Pfew.

$.02 💸

Member

jaybe-jekyll commented Oct 26, 2015

I need to correct myself; apologies --

I prefer a switch/command/trigger required to enable regeneration,

Building, Serving, Regenerating... all specific and chosen capabilities.

I would expect jekyll build to build once and end, returning as successful.

I would expect to jekyll build --regnerateto enable/turn on regeneration, with or without --watch, as --regeneration would presume --watch.

Pfew.

$.02 💸

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

I think -ir might get confusing. Maybe --ir or use just one character for a single dash.

Member

parkr commented Oct 26, 2015

I think -ir might get confusing. Maybe --ir or use just one character for a single dash.

@alfredxing

This comment has been minimized.

Show comment
Hide comment
@alfredxing

alfredxing Oct 26, 2015

Member

@parkr: Would you prefer -i or -r for the shorthand flag?

@jaybe-jekyll Not sure about the "flag presumes --watch" part, since incremental regen would offer a performance improvement even without watching (so users might want to enable it without enabling watch)

Member

alfredxing commented Oct 26, 2015

@parkr: Would you prefer -i or -r for the shorthand flag?

@jaybe-jekyll Not sure about the "flag presumes --watch" part, since incremental regen would offer a performance improvement even without watching (so users might want to enable it without enabling watch)

@jaybe-jekyll

This comment has been minimized.

Show comment
Hide comment
@jaybe-jekyll

jaybe-jekyll Oct 26, 2015

Member

Another opinion; I think the term, "incremental", in "incremental regeneration" (i.e. --ir) applies more to a technical audience and isn't necessarily necessary or appropriate for general use(rs).

Regenerate.

Agreed; single character enablement; perhaps -R (for, REGENERATION POWERS ACTIVATED). And, for the verbose and visually-minded, --regenerate and or --regeneration.

Member

jaybe-jekyll commented Oct 26, 2015

Another opinion; I think the term, "incremental", in "incremental regeneration" (i.e. --ir) applies more to a technical audience and isn't necessarily necessary or appropriate for general use(rs).

Regenerate.

Agreed; single character enablement; perhaps -R (for, REGENERATION POWERS ACTIVATED). And, for the verbose and visually-minded, --regenerate and or --regeneration.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

@parkr: Would you prefer -i or -r for the shorthand flag?

Historically, I have used -i for "case-insensitive", and -r for "recursive." I would go with the first character of the double-dashed one or an alternative if it isn't there.

Member

parkr commented Oct 26, 2015

@parkr: Would you prefer -i or -r for the shorthand flag?

Historically, I have used -i for "case-insensitive", and -r for "recursive." I would go with the first character of the double-dashed one or an alternative if it isn't there.

@jaybe-jekyll

This comment has been minimized.

Show comment
Hide comment
@jaybe-jekyll

jaybe-jekyll Oct 26, 2015

Member

@alfredxing I don't see how generation could occur within a system without --watch; does it not imply watching for changes (--watch) then acting on those changes (--regenerate)?

Member

jaybe-jekyll commented Oct 26, 2015

@alfredxing I don't see how generation could occur within a system without --watch; does it not imply watching for changes (--watch) then acting on those changes (--regenerate)?

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Oct 26, 2015

Contributor

@parkr @alfredxing: @jaybe-jekyll brings up a fine point, why not call the flag --cache? That's literally what it's doing, but we call it incremental regeneration as a technical term, when Occam is standing over there pointing to the term: caching.

Contributor

envygeeks commented Oct 26, 2015

@parkr @alfredxing: @jaybe-jekyll brings up a fine point, why not call the flag --cache? That's literally what it's doing, but we call it incremental regeneration as a technical term, when Occam is standing over there pointing to the term: caching.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

Does the sass compiler have a flag like this? Our Jekyllers tend to be front end devs so maybe Sass's CLI is known.

Member

parkr commented Oct 26, 2015

Does the sass compiler have a flag like this? Our Jekyllers tend to be front end devs so maybe Sass's CLI is known.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

@jaybe-jekyll Yeah, it's more about caching. --watch says "hey, regenerate every time you detect a changed file!" and --regenerate or --increment or --cache is "hey, when you do regenerate, only regenerate the changed files!". So they're different functions entirely. Eventually, --cache or whatever will be enabled by default, no matter if --watch is used.

Member

parkr commented Oct 26, 2015

@jaybe-jekyll Yeah, it's more about caching. --watch says "hey, regenerate every time you detect a changed file!" and --regenerate or --increment or --cache is "hey, when you do regenerate, only regenerate the changed files!". So they're different functions entirely. Eventually, --cache or whatever will be enabled by default, no matter if --watch is used.

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Oct 26, 2015

Contributor

Sass by default caches so they have a --force flag which forces it to update the cache even if it's cached.

Contributor

envygeeks commented Oct 26, 2015

Sass by default caches so they have a --force flag which forces it to update the cache even if it's cached.

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

@alfredxing just waiting on this PR. once it's merged, i'll release an RC and then do any final bug fixes before I release around 8pm PST tonight.

Member

parkr commented Oct 26, 2015

@alfredxing just waiting on this PR. once it's merged, i'll release an RC and then do any final bug fixes before I release around 8pm PST tonight.

@alfredxing

This comment has been minimized.

Show comment
Hide comment
@alfredxing

alfredxing Oct 26, 2015

Member

Sure! Right now I have it as -I and --incremental. If we don't think -I is appropriate, I can remove it!

Member

alfredxing commented Oct 26, 2015

Sure! Right now I have it as -I and --incremental. If we don't think -I is appropriate, I can remove it!

@envygeeks

This comment has been minimized.

Show comment
Hide comment
@envygeeks

envygeeks Oct 26, 2015

Contributor

-I is what I instantly thought of when you said you wanted --incremental so I'm 👍

Contributor

envygeeks commented Oct 26, 2015

-I is what I instantly thought of when you said you wanted --incremental so I'm 👍

alfredxing added some commits Oct 26, 2015

Rename incremental regeneration flag
Rename from `full_rebuild` to disable, to `incremental` to enable
@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

Looks great! Thanks so much, @alfredxing. I'll merge once it's 💚 .

Member

parkr commented Oct 26, 2015

Looks great! Thanks so much, @alfredxing. I'll merge once it's 💚 .

@alfredxing

This comment has been minimized.

Show comment
Hide comment
@alfredxing

alfredxing Oct 26, 2015

Member

👍

Good luck (& congrats!) on the launch tonight!

Member

alfredxing commented Oct 26, 2015

👍

Good luck (& congrats!) on the launch tonight!

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2015

Member

Good luck (& congrats!) on the launch tonight!

@alfredxing Congrats to you, too! It's been a huge team effort. Thanks for all your time and effort thus far – it's meant a lot!

Member

parkr commented Oct 26, 2015

Good luck (& congrats!) on the launch tonight!

@alfredxing Congrats to you, too! It's been a huge team effort. Thanks for all your time and effort thus far – it's meant a lot!

parkr added a commit that referenced this pull request Oct 26, 2015

@parkr parkr merged commit d6176d6 into jekyll:master Oct 26, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

parkr added a commit that referenced this pull request Oct 26, 2015

@alfredxing alfredxing deleted the alfredxing:disable-incremental-default branch Oct 26, 2015

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.