Upgrade Guide

Table of Contents

• Upgrade from Starter
• Upgrade the Fork
• Major Version Upgrades

---

Upgrade from Starter

If you are using the theme gem (there will be gem "jekyll-theme-chirpy" in the Gemfile), edit the Gemfile and update the version number of the theme gem. For example:

- gem "jekyll-theme-chirpy", "~> 3.2"
+ gem "jekyll-theme-chirpy", "~> 4.0"

Then execute the following command:

bundle update jekyll-theme-chirpy

As the version upgrades, critical files (see the startup template for details) and configuration options will change. You can use the GitHub API to get the file changes in the version upgrade.

The URL format is as follows:

https://github.com/cotes2020/chirpy-starter/compare/<older_version>...<newer_version>

For instance, to upgrade from v4.0.0 to v5.0.0, visit:
https://github.com/cotes2020/chirpy-starter/compare/v4.0.0...v5.0.0

Upgrade the Fork

If you forked from the source project (there will be gemspec in the Gemfile of your site), merge the latest upstream tags into your Jekyll site to complete the upgrade. The merge is likely to conflict with your local modifications. Please be patient and careful when resolving these conflicts.

JS distribution files have been removed since v5.6.0, and Bootstrap CSS has been lean since v7.0.0. Therefore, for all future upgrades, you should compile the CSS/JS files yourself.

npm run build

Then make sure to add them to your repository files:

git add assets/js/dist _sass/dist -f

Major Version Upgrades

When upgrading to a Major version, it's important to read the release notes for that version to understand any changes in project configuration.