Update Eggspress

Using Sync Fork

Update Eggspress with just one click
December 6, 2023

Over time, we'll make changes to the code that makes Eggspress work. These changes may:

  • Fix bugs
  • Add new features
  • Add new customization settings
  • Improve layout and appearances

In most cases, you can update Eggspress with just one click.

Sync Fork

The easiest way to sync your fork is to navigate to your forked repository page for Eggspress. To confirm if you're on your forked repository, look for the label "forked from dentonzh/Eggspress" under your repository name.

On this page look for a message above the list of repository files that reads:

This branch is *x* commits ahead, *y* commits behind dentonzh:main

If you are at least one commit behind, then there are new updates available.

To apply these updates, click the "Sync fork" button that appears to the right of the message. In the pop-up modal that appears, click "Update branch."

Warning: do not instruct Github to "Discard n commits." Doing so will remove your content and you will have to reupload your workspace to restore your site.

Syncing forks takes just a few seconds. When Github is done syncing, Vercel will begin building a new version of your site.

You may want to log into your Vercel dashboard to ensure that the build using the latest version of Eggspress is successful. If you experience errors, please follow the steps in Troubleshooting Your Build.

Issues with syncing

You may experience issues with syncing your fork if you have:

  • Modified any files outside of the my_-prefixed folders

To resolve these issues, you will need to resolve conflicts manually. This means selecting whether to keep your custom code or to use code from the upstream repository (that is, the main Eggspress repository).

"Sync fork" unavailable

If you do not see a button for "Sync fork," you may have:

  • Changed the visibility of your forked repository to "private"
  • Detached your fork

If you have, you will need to ensure that the visibility of your forked repository is set to "visible." If it is, contact Github support and request that they reattach your repository to the main Eggspress repository (dentonzh/Eggspress).

Alternatively, you can try these instructions to sync your fork using the command line.

Profile image for Denton Zhou
Denton Zhou
Maintainer
I'm here to help you start your new site using Eggspress!
Twitter: @dentonzh
Social: LinkedIn
logo