Skip to content
mcalinghee edited this page May 6, 2024 · 54 revisions

Tchap specifics

Release Process

If we want a new release , let's take the new release of : 4.3.3 where :

  • 4.3.3 is the version for tchap-web-v4
  1. Create a branch named "bump-to-4.3.3"

git checkout -b bump-to-4.3.3 develop_tchap

  1. update package.json
npm version 4.3.3 --no-commit-hooks --no-git-tag-version
  1. Regenerate the yarn.lock
rm yarn.lock
yarn install
  1. Commit your changes with the message "Bump to 4.3.3"
git add . && git commit -m "Bump to 4.3.3"
git push --set-upstream origin bump-to-4.3.3
  1. 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

    }

You can for example announce important new features.

  1. Verify that feature flags are correctly configured for your needs in config.json. In particular related to "tchap-features"

  2. Open a PR, verify with the Review App that the application builds and run correctly, and tests pass. Run the
    manual test checklist (unless you think the release is too small to be worth it...)

  3. Merge the PR after review.

  4. Create a new tag from develop_tchap and push it to the repo (add the prefix tchap-)

git checkout develop_tchap
git pull
git tag tchap-4.3.3
git push origin tchap-4.3.3
  1. DO NOT CREATE RELEASE BY HAND. The CI should create the release, triggered by the tag you pushed : https://github.com/tchapgouv/tchap-web-v4/releases

Check that the changelog looks good, you can add a little summary message at the top for easy reading.

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

  2. The product version tracker should be auto-updated (it links to the right file), if not fix it : https://www.notion.so/mercurial-timer-ec4/Suivi-des-versions-74129464bc194d398ebe0d5bdbd92dfb?pvs=4

Create patch (only matrix-js-sdk, matrix-react-sdk is using subtrees)

See this readme