Skip to content

Commit 63e2dde

Browse files
committed
Add more upgrade instructions
1 parent e25da59 commit 63e2dde

File tree

1 file changed

+43
-4
lines changed

1 file changed

+43
-4
lines changed

UPGRADE.md

+43-4
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,19 @@
44

55
### Location of git configuration changed
66

7+
**MANDATORY**
8+
9+
If you are using one or more of the git options (*requireBranch*, *pushToRemote* or *pushToCurrentBranch*) you need to adapt your configuration.
10+
711
In you build.gradle either replace:
812

9-
```git.option = 'value'``` with ```release.git.option = 'value'```
13+
```git.<option> = '<value>'``` with ```release.git.<option> = '<value>'```
1014

1115
or
1216

1317
```
1418
git {
15-
option = value
19+
<option> = <value>
1620
}
1721
```
1822

@@ -21,24 +25,59 @@ with
2125
```
2226
release {
2327
git {
24-
option = value
28+
<option> = <value>
2529
}
2630
}
2731
```
2832

2933
### Automatically uploading artifacts on release
3034

35+
**RECOMMENDED**
36+
3137
Formally it was usually done by adding
3238

3339
```
3440
createReleaseTag.dependsOn uploadArchives
3541
```
3642

37-
This **should not** be done anymore. (Although this will still work, but may have undesired side effects)
43+
This **should not** be done anymore. (Although this will still continue to work, but may have undesired side effects in the future)
3844

3945
Instead use
4046

4147
```
4248
afterReleaseBuild.dependsOn uploadArchives
4349
```
4450

51+
### Migrate to new ``tagTemplate`` configuration
52+
53+
**RECOMMENDED**
54+
55+
If you are using either ``includeProjectNameInTag`` or ``tagPrefix`` you should consider moving to ``tagTemplate``. The two options have been deprecated and will be removed in the future.
56+
57+
These two scenarios should make it easy to get the same result as before:
58+
59+
##### Scenario #1
60+
61+
* ``includeProjectNameInTag`` not set or set to false
62+
* ``tagPrefix`` set to "something"
63+
64+
Remove ``includeProjectNameInTag`` or ``tagPrefix`` and add
65+
```
66+
release {
67+
tagTemplate = "something-${version}"
68+
}
69+
```
70+
71+
##### Scenario #2
72+
73+
* ``includeProjectNameInTag`` set to true
74+
75+
Remove ``includeProjectNameInTag`` or ``tagPrefix`` and add
76+
77+
```
78+
release {
79+
tagTemplate = "${name}-${version}"
80+
}
81+
```
82+
83+

0 commit comments

Comments
 (0)