Initial Steps

The initial phase of the release process consists of

  • Locking the repository for merges
  • Ensuring all code is up to date
  • tagging the release

Locking Repository

While doing the initial steps of process release, at least up to the tagging release stage, we need to ensure that no commits/merges are created against the release branch and the main branch, except where necessary for the release.

Message all developers who have merge privileges using the Skype Dev Chat channel, and then lock the branch you are building. Go to the branches page and set a branch protection rule. Here is a list of branch protection rules for 158 for example. Click on the checkbox for Require a pull request before merging then set the required approvals to 6, and the branch will be effectively locked.

Updating Code

Before tagging a release we need to ensure code is up to date.

We need to update the Documentation Website to ensure that it reflects changes that have happened within the release and stamp files that have been changed/added with correct copyright and other headers.

Release Documentation

The Documenation Website contains details of changes between versions and general installation instructions.

The 2 main pages that need adding/updating are the Whats New and Changed Files pages. Note: The above links give examples of previous releases.

You will need to have checkout of the Zen Cart documentation website and be able to use the Hugo system to edit and test the pages locally before pushing changes,

While previously we would duplicate content in the /docs folder of the release and on the folder, these now redirect to the documentation website.

Still have questions? Use the Search box in the upper right, or try the full list of FAQs. If you can't find it there, head over to the Zen Cart support forum and ask there in the appropriate subforum. In your post, please include your Zen Cart and PHP versions, and a link to your site.

Is there an error or omission on this page? Please post to General Questions on the support forum. Or, if you'd like to open a pull request, just review the guidelines and get started. You can even PR right here.
Last modified July 25, 2022 by Scott C Wilson (1cbd8967).