You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributors/composite-builds.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,10 +17,10 @@ To do this, every library that depends on some other Cryptimeleon library includ
17
17
This script clones the dependency to the same directory level as the library being built and includes it as a composite build if possible.
18
18
"If possible" means that the branches should follow some rules. Let `LB` be the name of the branch of the library being built and `DB` be the name of the branch of the dependency library. The composite build will only be enabled if either of the following hold:
19
19
20
-
- The dependency has no branch called `LB` and `DB == main`. In this case, the `main` branch of the dependency is used for the composite build.
20
+
- The dependency has no branch called `LB` and `DB == develop`. In this case, the `develop` branch of the dependency is used for the composite build.
21
21
- The dependency has a branch called `LB` and `DB = LB`. In this case, the `DB` branch of the dependency is used for the composite build.
22
22
23
-
To summarize, the build script will always try to use the branch with the same name as `LB` and use `main` if no such branch exists.
23
+
To summarize, the build script will always try to use the branch with the same name as `LB` and use `develop` if no such branch exists.
24
24
Importantly, no automatic checkout of branches is done.
25
25
This means that if the branches don't match, the build script will complain and fail.
26
26
You can adjust this behaviour using the **useCurrentBranch** parameter as explained below.
@@ -36,7 +36,7 @@ For examples of how this works see [the examples section](#examples).
36
36
37
37
-**useCurrentBranch**: If defined (any value) the branch selection checking will be skipped.
38
38
That means the composite build will be enabled no matter the dependency branches that are currently checked out.
39
-
This can be useful for when you need a version that is not on `main` but you also do not want to create a new branch.
39
+
This can be useful for when you need a version that is not on `develop` but you also do not want to create a new branch.
40
40
-**checkoutIfCloned**: If defined (any value), will automatically check out the corresponding
41
41
dependency branch (branch with same name) given that the dependency was freshly cloned.
42
42
Used by the Travis CI to automatically switch to the right dependency branch for the build.
0 commit comments