perf(build): use jekyll-include-cache plugin to reduce build time

[cotes2020]

Description

Resolves #1094

Type of change

• Improvement (refactoring and improving code)

Additional context

Improvements to:

• Use jekyll-include-cache plugin to reduce build time #1097

How has this been tested

• I have run bash ./tools/test (at the root of the project) locally and passed
• I have tested this feature in the browser

[cotes2020]

Hi @jakerr, the include of the dynamic file is removed in this PR, what do you think?

[jakerr]

Looks great thank you!
I just found the one case where the template needs dynamic page info (the sidebar) I checked all of the other templates and they look good to cache to me.

Here's the perf for this change checked locally (on this site it was 4 minutes without this change):

Build Process Summary: 

| PHASE    |   TIME |
+----------+--------+
| RESET    | 0.0001 |
| READ     | 2.0448 |
| GENERATE | 0.0375 |
| RENDER   | 9.8069 |
| CLEANUP  | 0.0042 |
| WRITE    | 0.1675 |
 

Site Render Stats: 

| Filename                                                           | Count |      Bytes |  Time |
+--------------------------------------------------------------------+-------+------------+-------+
| _layouts/page.html                                                 |  1168 | 122040.89K | 6.781 |
| jekyll-theme-chirpy-6.0.1/_includes/related-posts.html             |   326 |   3514.48K | 6.367 |
| _layouts/default.html                                              |  1168 | 248613.28K | 1.806 |
| _includes/head.html                                                |  1168 |   5208.82K | 0.810 |
| jekyll-theme-chirpy-6.0.1/_includes/js-selector.html               |  1168 |    854.92K | 0.300 |
| jekyll-theme-chirpy-6.0.1/_includes/sidebar.html                   |  1168 |   2961.32K | 0.299 |

[jakerr]

Oh one more thing. How are you enabling the plugin? Is it automatic?
I thought I had to add this in _config.yml:

plugins:
  - jekyll-include-cache

[cotes2020]

Oh one more thing. How are you enabling the plugin? Is it automatic? I thought I had to add this in _config.yml:

plugins:
  - jekyll-include-cache

For the source code project here, the plugin is referenced in the jekyll-theme-chirpy.gemspec file.

jekyll-theme-chirpy/jekyll-theme-chirpy.gemspec

Line 34 in 42f4760

spec.add_runtime_dependency "jekyll-include-cache", "~> 0.2"

For users who use the gem package, currently until the new Chirpy gem is released, the jekyll-include-cache plugin needs to be imported in the Gemfile.

[jakerr]

For the source code project here, the plugin is referenced in the jekyll-theme-chirpy.gemspec file.

Ah thanks. I wasn't aware of the difference between depending on _plugins in a Jekyll site and depending on them from normal libs when writing plugins. Found a bit of info on that here.

This PR looks good to me.

[cotes2020]

In fact, there is no need to modify _config.yml to use the plugin, you can use the :jekyll_plugins Gemfile group