Skip to content

Commit b069b90

Browse files
florianlacreuseflorianlacreuse
committed
Update Igloo release doc
1 parent c2d0154 commit b069b90

1 file changed

Lines changed: 104 additions & 17 deletions

File tree

‎source/maven/releasing.md‎

Lines changed: 104 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11

22
# Releasing
33

4-
## Releasing igloo
4+
## Igloo
55

66
```{note}
77
Releasing can be performed only for `igloo-parent` if `igloo-maven` / `igloo-commons` are untouched.
88
Just set IGLOO_XXX_VERSION accordingly and start procedure at `igloo-parent` step.
99
```
1010

11+
Commands listed below allow for each Igloo sub-project to update igloo dependencies version, perform commit,
12+
and push to repository. Release is performed by CI/CD.
13+
14+
### Release
15+
1116
```bash
1217
IGLOO_MAVEN_VERSION=xxx
1318
IGLOO_COMMONS_VERSION=xxx
19+
IGLOO_PARENT_VERSION=xxx
1420

1521
###############
1622
# igloo-maven #
@@ -29,8 +35,7 @@ mvn versions:update-parent -pl . -DparentVersion=$IGLOO_MAVEN_VERSION -DskipReso
2935
# update igloo.igloo-maven.version property
3036
mvn versions:set-property -Dproperty=igloo.igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
3137
# check changes with git diff
32-
git add -A
33-
git commit
38+
git commit -a -m "Update Igloo Maven dependency"
3439
# perform jgitflow release
3540
mvn jgitflow:release-start
3641
mvn -DskipTests -DnoDeploy jgitflow:release-finish
@@ -46,51 +51,133 @@ mvn versions:update-parent -pl .,:igloo-parent-maven-configuration-common -Dpare
4651
mvn versions:set-property -Dproperty=igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
4752
mvn versions:set-property -Dproperty=igloo-commons.version -DnewVersion=$IGLOO_COMMONS_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
4853
# check changes with git diff
49-
git add -A
50-
git commit
54+
git commit -a -m "Update Igloo Maven and Commons dependencies"
5155
# perform jgitflow release
5256
mvn jgitflow:release-start
5357
mvn -DskipTests -DnoDeploy jgitflow:release-finish
54-
git push origin master dev vX.X.X
58+
git push origin master dev v$IGLOO_PARENT_VERSION
5559

5660
########################################
5761
# Switch back to snapshot dependencies #
5862
########################################
5963

60-
IGLOO_MAVEN_VERSION=xxx-SNAPSHOT
61-
IGLOO_COMMONS_VERSION=xxx-SNAPSHOT
64+
IGLOO_MAVEN_VERSION_SNAPSHOT=xxx-SNAPSHOT
65+
IGLOO_COMMONS_VERSION_SNAPSHOT=xxx-SNAPSHOT
6266

6367
#################
6468
# igloo-commons #
6569
#################
6670

6771
git checkout dev
72+
# update parent
73+
mvn versions:update-parent -pl . -DparentVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DskipResolution -DgenerateBackupPoms=false
74+
# update igloo.igloo-maven.version property
75+
mvn versions:set-property -Dproperty=igloo.igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DprocessAllModules=true -DgenerateBackupPoms=false
76+
git commit -a -m "Switch back Igloo Maven to snapshort versions"
77+
git push
78+
79+
################
80+
# igloo-parent #
81+
################
82+
83+
git checkout dev
84+
# update parents
85+
mvn versions:update-parent -pl .,:igloo-parent-maven-configuration-common -DparentVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DskipResolution -DgenerateBackupPoms=false
86+
# update igloo-maven.version, igloo-commons.version
87+
mvn versions:set-property -Dproperty=igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DprocessAllModules=true -DgenerateBackupPoms=false
88+
mvn versions:set-property -Dproperty=igloo-commons.version -DnewVersion=$IGLOO_COMMONS_VERSION_SNAPSHOT -DprocessAllModules=true-DgenerateBackupPoms=false
89+
git commit -a -m "Switch back Igloo Maven and Commons to snapshot versions"
90+
git push
91+
```
92+
93+
### Hotfix
94+
95+
```bash
96+
IGLOO_MAVEN_VERSION=xxx
97+
IGLOO_COMMONS_VERSION=xxx
98+
IGLOO_PARENT_VERSION=xxx
99+
100+
IGLOO_MAVEN_VERSION_SNAPSHOT=xxx-SNAPSHOT
101+
IGLOO_COMMONS_VERSION_SNAPSHOT=xxx-SNAPSHOT
102+
103+
###############
104+
# igloo-maven #
105+
###############
106+
107+
mvn jgitflow:hotfix-start
108+
# git push -u origin hf-$IGLOO_MAVEN_VERSION
109+
110+
mvn -DskipTests -DnoDeploy jgitflow:hotfix-finish
111+
git push origin main dev v$IGLOO_MAVEN_VERSION
112+
113+
#################
114+
# igloo-commons #
115+
#################
116+
117+
mvn jgitflow:hotfix-start
118+
# git push -u origin hf-$IGLOO_COMMONS_VERSION
119+
68120
# update parent
69121
mvn versions:update-parent -pl . -DparentVersion=$IGLOO_MAVEN_VERSION -DskipResolution -DgenerateBackupPoms=false
70122
# update igloo.igloo-maven.version property
71123
mvn versions:set-property -Dproperty=igloo.igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
72-
git commit -a -m "switch back to SNAPSHOT"
73-
git push
124+
# check changes with git diff
125+
git commit -a -m "Update Igloo Maven dependency"
126+
127+
# update dev poms to hotfix version to avoid merge conflicts (Igloo sub-project)
128+
git checkout dev
129+
mvn versions:update-parent -pl . -DparentVersion=$IGLOO_MAVEN_VERSION -DskipResolution -DgenerateBackupPoms=false
130+
mvn versions:set-property -Dproperty=igloo.igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
131+
git commit -a -m "Updating dev poms to hotfix version to avoid merge conflicts (Igloo sub-project)"
132+
133+
mvn -DskipTests -DnoDeploy jgitflow:hotfix-finish
134+
135+
# update develop poms back to pre merge state (Igloo sub-project)
136+
git checkout dev
137+
mvn versions:update-parent -pl . -DparentVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DskipResolution -DgenerateBackupPoms=false
138+
mvn versions:set-property -Dproperty=igloo.igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DprocessAllModules=true -DgenerateBackupPoms=false
139+
git commit -a -m "Updating develop poms back to pre merge state (Igloo sub-project)"
140+
141+
git push origin main dev v$IGLOO_COMMONS_VERSION
74142

75143
################
76144
# igloo-parent #
77145
################
78146

147+
mvn jgitflow:hotfix-start
148+
# git push -u origin hf-$IGLOO_PARENT_VERSION
149+
150+
# update parents
151+
mvn versions:update-parent -pl .,:igloo-parent-maven-configuration-common -DparentVersion=$IGLOO_MAVEN_VERSION -DskipResolution -DgenerateBackupPoms=false
152+
# update igloo-maven.version, igloo-commons.version
153+
mvn versions:set-property -Dproperty=igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
154+
mvn versions:set-property -Dproperty=igloo-commons.version -DnewVersion=$IGLOO_COMMONS_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
155+
git commit -a -m "Update Igloo Maven and Commons dependencies"
156+
157+
# update dev poms to hotfix version to avoid merge conflicts (Igloo sub-project)
79158
git checkout dev
80159
# update parents
81160
mvn versions:update-parent -pl .,:igloo-parent-maven-configuration-common -DparentVersion=$IGLOO_MAVEN_VERSION -DskipResolution -DgenerateBackupPoms=false
82161
# update igloo-maven.version, igloo-commons.version
83162
mvn versions:set-property -Dproperty=igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
84163
mvn versions:set-property -Dproperty=igloo-commons.version -DnewVersion=$IGLOO_COMMONS_VERSION -DprocessAllModules=true -DgenerateBackupPoms=false
85-
git commit -a -m "switch back to SNAPSHOT"
86-
git push
164+
git commit -a -m "Updating dev poms to hotfix version to avoid merge conflicts (Igloo sub-project)"
87165

88-
```
166+
mvn -DskipTests -DnoDeploy jgitflow:hotfix-finish
89167

90-
Commands listed above allow for each Igloo sub-project to update igloo dependencies version, perform commit,
91-
and push to repository. Release is performed by CI/CD.
168+
# update develop poms back to pre merge state (Igloo sub-project)
169+
git checkout dev
170+
# update parents
171+
mvn versions:update-parent -pl .,:igloo-parent-maven-configuration-common -DparentVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DskipResolution -DgenerateBackupPoms=false
172+
# update igloo-maven.version, igloo-commons.version
173+
mvn versions:set-property -Dproperty=igloo-maven.version -DnewVersion=$IGLOO_MAVEN_VERSION_SNAPSHOT -DprocessAllModules=true -DgenerateBackupPoms=false
174+
mvn versions:set-property -Dproperty=igloo-commons.version -DnewVersion=$IGLOO_COMMONS_VERSION_SNAPSHOT -DprocessAllModules=true-DgenerateBackupPoms=false
175+
git commit -a -m "Updating develop poms back to pre merge state (Igloo sub-project)"
176+
177+
git push origin master dev v$IGLOO_PARENT_VERSION
178+
```
92179

93-
## Releasing org.iglooproject.webjars:boostrap4
180+
## org.iglooproject.webjars:boostrap4
94181

95182
Repository https://github.com/igloo-project/bootstrap4 is a lightweight wrapper to
96183
repackage `org.webjars.npm:bootstrap` under a specific groupId/artifactId. This is
@@ -99,7 +186,7 @@ needed to allow embedding of different bootstrap version in the same igloo proje
99186

100187
If a new bootstrap version is needed, change project version and push modification on main branch. main branch is automatically published.
101188

102-
## Updating an igloo-based project
189+
## Updating an Igloo-based project
103190

104191
Once `igloo-parent` is released:
105192

0 commit comments

Comments
 (0)