Home

Tchap specifics

Les forks

Different fork to maintain added to the element-web repo

• Element call https://github.com/tchapgouv/element-call . We use the embedded version which fail to be patched the regular way (with patch-package). So we use our own build of the fork hosted on npm element-call-embdeed-tchap
• Compound-web https://github.com/tchapgouv/compound-web . Direct link to our github fork fail. So we use our own npm package compound-web-tchap
• Compound-design-token https://github.com/tchapgouv/compound-design-tokens . We directly use the github link in the project for this fork

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

2. update package.json

npm version 4.3.3 --no-commit-hooks --no-git-tag-version

3. Regenerate the yarn.lock

rm yarn.lock
yarn install

3. 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

7. 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.

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

6. 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...)

7. Merge the PR after review.

8. 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

7. 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.

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

9. 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

See this readme