Skip to content

Home

Jump to bottom
Audrey Lambert edited this page Mar 20, 2023 · 54 revisions

Tchap specifics

Release Process

If we want a new release , let's take the new release of : 4.1.6-1.11.17 where :

  • 4.1.6 is the version for tchap-web-v4
  • 1.11.17 is the version for element-web
  1. Create a branch named bump-to-4.1.6-1.11.17
  2. update package.json
"version": "4.1.5-1.11.17" => "version": "4.1.6-1.11.17"
  1. Generate the yarn.lock
yarn install
  1. Commit your changes with the message "Bump to 4.1.6-1.11.17"
  2. Open a PR and have it validated
  3. Create a new tag from develop_tchap and push it to the repo (add the prefix tchap-)
git tag tchap-4.1.6-1.11.17
git push origin tchap-4.1.6-1.11.17

  1. Verify that feature flags are correctly configured for your needs in config.json. In particular related to the cross-signing features: tchap_activate_cross_signing_and_secure_storage and tchap_disable_cross_signing_setup_toast.

  2. Optionnaly add a welcome message to for users (user notice) see : https://github.com/vector-im/element-web/blob/develop/docs/config.md#customisation--branding You need to edit these entries in the config.json:

    "user_notice": {
        "title": "...", // required
        "description": "...", // required
        "show_once":true/false // optional

    }

DO NOT CREATE RELEASE BY HAND. The CI should create the release : https://github.com/tchapgouv/tchap-web-v4/releases/tag/tchap-4.1.6-1.11.17 with all assets.

  1. For the next steps, go see the wiki in the infra repo.

Create patch

Create a patch of matrix-react-sdk for a new feature :

patch-package --patch-dir patches/myfeature --include path/to/react-sdk/files/modified matrix-react-sdk

(the --include arg is so that only your modification is included in your patch. By default, patch-package throws all modifications into the same file, which is harder to keep track.)

This creates the file : patches/myfeature/matrix-react-sdk+3.53.0.patch (or whatever version number you are patching)

Then, the postinstall script will apply each patch separately, you don't need to do anything. It will run: patch-package --patch-dir patches/myfeature

Edit : if you are a human, you can view patch files in Vscode with this extension for example : Diff Viewer VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=caponetto.vscode-diff-viewer

Clone this wiki locally