Creating a Release

Wagtail Patch Instructions

We need to patch each release of Wagtail to maintain compatabillity with Microsoft SQL Server.

Paul applies the patch (modifies migrations to delete and recreate indexes?).

Build Wagtail

1. Open our fork of Wagtail in PyCharm.

2. Open terminal in PyCharm.

3. Update repo:

   git fetch origin --recurse-submodules=no --progress --prune

4. Checkout patch branch (get branch name from Paul):

   git checkout -b 5.2_patch origin/5.2.1_patch --

5. Build Wagtail project with following commands:

   nvm use
   npm install
   python3 ./setup.py sdist bdist_wheel

File will be located in /Users/rjschave/pycharm-projects/clients/eci/wagtail/dist and will match the branch name. Using the example above in step 4, the file would be named wagtail-5.2.1.tar.gz.

Create a Release

1. Create a new release our Wagtail repo with the following information (update info to match version):

   Tag: v5.2.1_patch

   Title: 5.2.1_patch

   Notes: Document the changes. Example:

   0072 patch
   0082 patch
   

   Attach the binary.

   Publish the release.

Using Our Patched Version of Wagtail

1. You can pip install our patched version of Wagtail

pip install https://github.com/eclipseconsulting/wagtail/releases/download/v5.2_patch/wagtail-5.2.tar.gz

You can also include https://github.com/eclipseconsulting/wagtail/releases/download/v5.2_patch/wagtail-5.2.tar.gz in a requirements file.