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