|
2 | 2 |
|
3 | 3 | ## Pre-requisites |
4 | 4 |
|
5 | | -1. Review changes in [element-web releases](https://github.com/element-hq/element-web/releases) |
| 5 | +#### 1. Review changes in [element-web releases](https://github.com/element-hq/element-web/releases) |
6 | 6 |
|
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) |
| 7 | +#### 2. 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 | 8 |
|
9 | | -1. Sync js-sdk fork [elecordapp/matrix-js-sdk](https://github.com/elecordapp/matrix-js-sdk) |
| 9 | +#### 3. Sync js-sdk fork [elecordapp/matrix-js-sdk](https://github.com/elecordapp/matrix-js-sdk) |
10 | 10 |
|
11 | | - > [!NOTE] |
12 | | - > Create a [backup branch](https://github.com/elecordapp/matrix-js-sdk/branches) before syncing the upstream |
| 11 | +> [!NOTE] |
| 12 | +> Create a [backup branch](https://github.com/elecordapp/matrix-js-sdk/branches) before syncing the upstream |
13 | 13 |
|
14 | 14 | ## Merge |
15 | 15 |
|
16 | | -1. Create a new branch named `element-v1.xx.xx` |
| 16 | +#### 1. Create a new branch named `element-v1.xx.xx` |
17 | 17 |
|
18 | | - > [!IMPORTANT] |
19 | | - > Run `gitrm.sh` to ensure elecord hasn't added back any upstream files |
| 18 | +> [!IMPORTANT] |
| 19 | +> Run `gitrm.sh` to ensure elecord hasn't added back any upstream files |
20 | 20 |
|
21 | | -1. Merge the upstream master branch |
| 21 | +#### 2. Merge the upstream master branch |
22 | 22 |
|
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` |
| 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` |
28 | 28 |
|
29 | | -1. Resolve merge conflicts |
| 29 | +#### 3. Resolve merge conflicts |
30 | 30 |
|
31 | | - > [!IMPORTANT] |
32 | | - > Run `gitrm.sh` to discount previously removed upstream files |
| 31 | +> [!IMPORTANT] |
| 32 | +> Run `gitrm.sh` to discount previously removed upstream files |
33 | 33 |
|
34 | | - > [!TIP] |
35 | | - > Always use the branch file for... |
36 | | - > - CHANGELOG.md |
37 | | - > - README.md |
38 | | - > <br><br> |
39 | | - > |
40 | | - > Always use the upstream file for... |
41 | | - > - yarn.lock |
| 34 | +> [!TIP] |
| 35 | +> Always use the branch file for... |
| 36 | +> - CHANGELOG.md |
| 37 | +> - README.md |
| 38 | +> <br><br> |
| 39 | +> |
| 40 | +> Always use the upstream file for... |
| 41 | +> - yarn.lock |
42 | 42 |
|
43 | | - > [!WARNING] |
44 | | - > Don't use the `package.json` branch file, instead resolve merge conflicts as there might be unseen changes |
| 43 | +> [!WARNING] |
| 44 | +> Don't use the `package.json` branch file, instead resolve merge conflicts as there might be unseen changes |
45 | 45 |
|
46 | | -1. Complete the merge process |
| 46 | +#### 4. Complete the merge process |
47 | 47 |
|
48 | 48 | ## Review |
49 | 49 |
|
50 | | -1. Check for any new files added or unwanted changes |
| 50 | +#### 1. Check for any new files added or unwanted changes |
51 | 51 |
|
52 | | - > [!NOTE] |
53 | | - > You can amend the merge commit as needed |
| 52 | +> [!NOTE] |
| 53 | +> You can amend the merge commit as needed |
54 | 54 |
|
55 | | -1. Build the app locally and test |
| 55 | +#### 2. Build the app locally and test |
56 | 56 |
|
57 | | -1. Commit the yarn.lock file `chore: update yarn.lock` |
| 57 | +#### 3. Commit the yarn.lock file `chore: update yarn.lock` |
58 | 58 |
|
59 | | - > [!WARNING] |
60 | | - > Only include additions, no local paths or minified package locks |
| 59 | +> [!WARNING] |
| 60 | +> Only include additions, no local paths or minified package locks |
61 | 61 |
|
62 | | -1. Commit any required regression fixes |
| 62 | +#### 4. Commit any required regression fixes |
63 | 63 |
|
64 | | - > [!NOTE] |
65 | | - > 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 |
66 | 66 |
|
67 | | -1. Publish the branch |
| 67 | +#### 5. Publish the branch |
68 | 68 |
|
69 | 69 | ## Pull Request |
70 | 70 |
|
71 | | -1. Create a pull request named `Element v1.xx.xx` |
| 71 | +#### 1. Create a pull request named `Element v1.xx.xx` |
72 | 72 |
|
73 | 73 | > Merge upstream Element-web v1.11.xx-yy. |
74 | 74 | > - Bundles new feature A |
75 | 75 | > - Adds important feature B |
76 | 76 |
|
77 | | -1. Test the app |
| 77 | +#### 2. Test the app |
78 | 78 |
|
79 | | -1. Merge (don’t squash) |
| 79 | +#### 3. Merge (don’t squash) |
80 | 80 |
|
81 | 81 | <br> |
82 | 82 |
|
|
0 commit comments