Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit b70b5eb

Browse files
committed
[[ README ]] Document PR procedure
This patch adds notes about the required order of events when patching this repo. Specifically it documents the different procedures for updating the `develop-9.0` branch and the `develop` branch.
1 parent a4448b3 commit b70b5eb

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# LiveCode Thirdparty Libraries
2+
3+
The procedure for updating `thirdparty` on `develop-9.0` and `develop` branches is
4+
slightly different due to `thirdparty` prebuilts on develop.
5+
6+
## Update procedure for develop-9.0
7+
8+
1. Push up a PR to this repo
9+
2. If there is a related patch to another repos then push up a PR for those
10+
3. Create a test branch on `livecode` with updated submodule ptrs. Ensure the
11+
branch is pushed upstream rather than to your clone.
12+
4. If it was a CEF update then push up a branch to `livecode-private` again with
13+
updated submodule and kick off prebuilts on vulcan.
14+
5. Create a PR with the title beginning with `[[ NO MERGE ]]` and review it ok
15+
to confirm it passes on travis and vulcan
16+
6. Close PR from 5 and link to it in the other related PRs
17+
7. Once all related PRs are reviewed merge `thirdparty`, update submodules in
18+
`livecode` and merge any related PRs
19+
20+
## Update procedure for develop
21+
22+
The same procedure applies to merge-ups from `develop-9.0` because the
23+
`thirdparty` prebuilts must be rebuilt for the current head of the `develop`
24+
branch.
25+
26+
1. Push up a PR to this repo
27+
2. If there is a related patch to another repos then push up a PR for those
28+
3. Review and merge the PR for `thirdparty` but *do not* update submodule ptrs
29+
in `livecode` yet.
30+
4. Create a test branch on `livecode` with updated submodule ptrs. Ensure the
31+
branch is pushed upstream rather than to your clone.
32+
5. Push up a branch to `livecode-private` again with updated submodule and kick
33+
off prebuilts on vulcan.
34+
6. Once prebuilts are built for the `develop` head of `thirdparty` create a PR
35+
using the `livecode` branch with the title beginning with `[[ NO MERGE ]]` and
36+
review it ok to confirm it passes on travis and vulcan
37+
7. Close PR from 6 and link to it in the other related PRs
38+
8. Once all related PRs are reviewed, update submodules in `livecode` and merge
39+
any related PRs

0 commit comments

Comments
 (0)