Google Git
Sign in
gerrit / gerrit / d7dc7207389fd87fbc0f00e58265a6c612dfb84d / . / Documentation / dev-release-subproject.txt
blob: fcafea5a9d39e9be08a2ee21d59c83787a1a25cb [file] [log] [blame]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]1= Making a Release of a Gerrit Subproject
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]2
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]3[[make-snapshot]]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]4== Make a Snapshot
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]5
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]6* Build the latest snapshot and install it into the local Maven
7repository:
8+
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]9----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]10 mvn clean install
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]11----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]12
13* Test Gerrit with this snapshot locally
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]14
15
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]16== Publish Snapshot
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]17
David Pursehouse383a3182013-12-06 13:06:57 +0900[diff] [blame]18If a snapshot for a subproject was created that should be referenced by
19Gerrit while current Gerrit development is ongoing, this snapshot needs
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]20to be published.
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]21
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]22* Make sure you have done the configuration needed for deployment:
23** link:dev-release-deploy-config.html#deploy-configuration-settings-xml[
24Configuration in Maven `settings.xml`]
25** link:dev-release-deploy-config.html#deploy-configuration-subprojects[
26Configuration for Subprojects in `pom.xml`]
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]27
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]28* Deploy the new snapshot:
29+
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]30----
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]31 mvn deploy
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]32----
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]33
David Pursehouse383a3182013-12-06 13:06:57 +0900[diff] [blame]34* Change the `id`, `bin_sha1`, and `src_sha1` values in the `maven_jar`
35for the subproject in `/lib/BUCK` to the `SNAPSHOT` version.
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]36+
David Pursehouse383a3182013-12-06 13:06:57 +0900[diff] [blame]37When Gerrit gets released, a release of the subproject has to be done
38and Gerrit has to reference the released subproject version.
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]39
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]40
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]41[[prepare-release]]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]42== Prepare the Release
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]43
44* link:#make-snapshot[First create (and test) the latest snapshot for
David Pursehouse383a3182013-12-06 13:06:57 +0900[diff] [blame]45the subproject]
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]46
David Pursehouse383a3182013-12-06 13:06:57 +0900[diff] [blame]47* Update the top level `pom.xml` in the subproject to reflect
Edwin Kempin67e09dc2012-07-23 10:46:06 +0200[diff] [blame]48the new project version (the exact value of the tag you will create
49below)
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]50
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]51* Create the Release Tag
52+
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]53----
54 git tag -a -m "prolog-cafe 1.3" v1.3
55----
Martin Fickec31ff42012-06-23 11:35:39 -0600[diff] [blame]56
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]57* Build and install into local Maven repository:
58+
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]59----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]60 mvn clean install
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]61----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]62
63
64[[publish-release]]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800[diff] [blame]65== Publish the Release
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]66
67* Make sure you have done the configuration needed for deployment:
68** link:dev-release-deploy-config.html#deploy-configuration-settings-xml[
69Configuration in Maven `settings.xml`]
70** Configuration in `pom.xml` for
David Pursehouse383a3182013-12-06 13:06:57 +0900[diff] [blame]71link:dev-release-deploy-config.html#deploy-configuration-subprojects[subprojects]
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]72
Martin Fick21e278e2012-02-23 13:45:54 -0700[diff] [blame]73* Deploy the new release:
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]74+
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]75----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]76 mvn deploy
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]77----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]78
79* Push the pom change(s) to the project's repository
80`refs/for/<master|stable>`
81
82* Push the Release Tag
83+
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]84----
Edwin Kempinbb8e6252012-07-31 14:30:35 +0200[diff] [blame]85 git push gerrit-review refs/tags/v1.3:refs/tags/v1.3
Michael Ochmannb99feab2016-07-06 14:10:22 +0200[diff] [blame]86----
Martin Fickec31ff42012-06-23 11:35:39 -0600[diff] [blame]87
88
89GERRIT
90------
91Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -0700[diff] [blame]92
93SEARCHBOX
94---------