Skip to content
This repository was archived by the owner on Feb 11, 2026. It is now read-only.

Commit ad25e52

Browse files
committed
docs: improve element merge guide
1 parent 0024100 commit ad25e52

1 file changed

Lines changed: 52 additions & 22 deletions

File tree

MERGE_ELEMENT.md

Lines changed: 52 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,84 @@
11
# Merge upstream `element-web` into `master`
22

3-
Pre-requisites
4-
- Review [element-web releases](https://github.com/element-hq/element-web/releases)
5-
- Sync fork [elecordapp/matrix-js-sdk](https://github.com/elecordapp/matrix-js-sdk)
3+
## Pre-requisites
64

7-
---
5+
1. Review changes in [element-web releases](https://github.com/element-hq/element-web/releases)
86

9-
1. Create a branch named 'element-v1.xx.xx'
7+
1. Review any changes to the app's [config.json file](https://github.com/element-hq/element-web/blob/master/element.io/app/config.json)
8+
9+
1. Sync js-sdk fork [elecordapp/matrix-js-sdk](https://github.com/elecordapp/matrix-js-sdk)
10+
11+
> [!NOTE]
12+
> Create a [backup branch](https://github.com/elecordapp/matrix-js-sdk/branches) before syncing the upstream
13+
14+
## Merge
15+
16+
1. Create a new branch named `element-v1.xx.xx`
17+
18+
> [!IMPORTANT]
19+
> Run `gitrm.sh` to ensure elecord hasn't added back any upstream files
1020
1121
1. Merge the upstream master branch
1222

13-
> On GitHub desktop:
14-
> - Select 'Choose a branch to merge into element-v1.xx.xx'
15-
> - Select 'upstream/master'
16-
> - Select 'Create a merge commit'
23+
> [!TIP]
24+
> Using GitHub Desktop
25+
> - Select `Choose a branch to merge into element-v1.xx.xx`
26+
> - Select `upstream/master`
27+
> - Select `Create a merge commit`
1728
1829
1. Resolve merge conflicts
1930

20-
> Use branch file
31+
> [!IMPORTANT]
32+
> Run `gitrm.sh` to discount previously removed upstream files
33+
34+
> [!TIP]
35+
> Always use the branch file for...
2136
> - CHANGELOG.md
2237
> - README.md
23-
24-
> Use upstream/master
38+
> <br><br>
39+
>
40+
> Always use the upstream file for...
2541
> - yarn.lock
2642
27-
> Run gitrm.sh
28-
> `git rm --cached -r docs\config.md`
29-
> `git rm --cached -r playwright`
43+
> [!WARNING]
44+
> Don't use the `package.json` branch file, instead resolve merge conflicts as there might be unseen changes
45+
46+
1. Complete the merge process
3047

31-
> Do not use the `package.json` branch file, resolve merge conflicts as there might be unseen changes
48+
## Review
3249

3350
1. Check for any new files added or unwanted changes
3451

35-
1. Run the build locally
52+
> [!NOTE]
53+
> You can amend the merge commit as needed
54+
55+
1. Build the app locally and test
3656

37-
1. Commit the yarn lock 'chore: update yarn.lock'
57+
1. Commit the yarn.lock file `chore: update yarn.lock`
3858

59+
> [!WARNING]
3960
> Only include additions, no local paths or minified package locks
4061
4162
1. Commit any required regression fixes
4263

43-
> Note, any commits made to this branch won't be included in the changelog
64+
> [!NOTE]
65+
> Any commits made to this branch won't be included in the changelog
4466
4567
1. Publish the branch
4668

47-
1. Create a pull request ('Element v1.XX.XX')
69+
## Pull Request
70+
71+
1. Create a pull request named `Element v1.xx.xx`
72+
73+
> Merge upstream Element-web v1.11.xx-yy.
74+
> - Bundles new feature A
75+
> - Adds important feature B
4876
4977
1. Test the app
5078

5179
1. Merge (don’t squash)
5280

53-
> [!IMPORTANT]
54-
> elecord-desktop will also need to be updated
81+
<br>
82+
83+
> [!CAUTION]
84+
> `elecord-desktop` will also need to be updated, simply repeat these steps

0 commit comments

Comments
 (0)