Skip to content

Commit 7660ce8

Browse files
author
Alexander Ben Nasrallah
committed
Add release section to README
1 parent cf3df57 commit 7660ce8

File tree

1 file changed

+58
-1
lines changed

1 file changed

+58
-1
lines changed

README.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Substitute `oracle-account-username` with the user name of your Oracle account
9999
and `oracle-account-password` with an encrypted version of your Oracle account
100100
password. Use `mvn -ep` to encrypt it.
101101

102-
### Test
102+
## Testing
103103
Integration tests are written in python using [Requests][]
104104
and standard python [unittest][py-unittest].
105105

@@ -127,3 +127,60 @@ VERINICEDB=databasename VERINICEUSER=user VERINICEPASSWORD=password ./integratio
127127

128128
[Requests]: http://docs.python-requests.org/en/latest/ "Requests: HTTP for Humans"
129129
[py-unittest]: https://docs.python.org/3/library/unittest.html "unittest in python"
130+
131+
## Releasing
132+
To release a new version (here 0.1 is assumed) of the project, you should
133+
134+
1. Initially checkout the `develop` branch.
135+
2. Create a new branch `release/0.1`
136+
137+
git checkout -b release/0.1
138+
139+
3. Until QA gives green light:
140+
1. Update project version using maven.
141+
142+
mvn versions:set -DnewVersion=0.1-beta1
143+
144+
2. Commit, tag and push the release branch with updated version.
145+
146+
git commit -a
147+
git push origin release/0.1
148+
git tag -s 0.1-beta1
149+
git push origin 0.1-beta1
150+
151+
3. Checkout the beta tag.
152+
153+
git checkout 0.1-beta1
154+
155+
4. Do a deployment build.
156+
157+
mvn clean package
158+
159+
5. Put deployment to QA.
160+
6. If QA fails, fix bugs onto branch `feature/0.1` and jump back to 3.1.
161+
4. Update the project version.
162+
163+
mvn versions:set -DnewVersion=0.1
164+
git commit -a
165+
git push origin release/0.1
166+
167+
5. Merge the release branch to master and tag.
168+
169+
git checkout master
170+
git merge --no-ff release/0.1
171+
git tag -s 0.1
172+
173+
6. Checkout the tag.
174+
175+
git checkout 0.1
176+
177+
7. Do a deployment build.
178+
179+
mvn clean package
180+
181+
8. Release deployment.
182+
9. Merge the release branch to develop to get bugfixes.
183+
184+
git co develop
185+
git merge --no-ff release/0.1
186+
git push origin develop

0 commit comments

Comments
 (0)