You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

version.sh 4.9KB

Switch build to Apache Felix maven-bundle-plugin Tycho isn't production ready for projects like JGit to be using as their primary build driver. Some problems we ran into with Tycho 0.6.0 that are preventing us from using it are: * Tycho can't run offline The P2 artifact resolver cannot perform its work offline. If the build system has no network connection, it cannot compile a project through Tycho. This is insane for a distributed version control system where developers are used to being offline during development and local testing. * Magic state in ~/.m2/repository/.meta/p2-metadata.properties Earlier iterations of this patch tried to use a hybrid build, where Tycho was only used for the Eclipse specific feature and P2 update site, and maven-bundle-plugin was used for the other code. This build seemed to work, but only due to magic Tycho specific state held in my local home directory. This means builds are not consistently repeatable across systems, and lead me to believe I had a valid build, when in fact I did not. * Manifest-first build produces incomplete POMs The POM created by the manifest-first build format does not contain the dependency chain, leading a downstream consumer to not import the runtime dependencies necessary to execute the bundle it has imported. In JGit's case, this means JSch isn't included in our dependency chain. * Manifest-first build produces POMs unreadable by Maven 2.x JGit has existing application consumers who are relying on Maven 2.x builds. Forcing them to step up to an alpha release of Maven 3 is simply unacceptable. * OSGi bundle export data management is tedious Editing each of our pom.xml files to mark a new release is difficult enough as it is. Editing every MANIFEST.MF file to list our exported packages and their current version number is something a machine should do, not a human. Yet the Tycho OSGi way unfortunately demands that a human do this work. * OSGi bundle import data management is tedious There isn't a way in the MANIFEST.MF file format to reuse the same version tags across all of our imports, but we want to have a consistent view of our dependencies when we compile JGit. After wasting more than 2 full days trying to get Tycho to work, I've decided its a lost cause right now. We need to be chasing down bugs and critical features, not trying to bridge the gap between the stable Maven repository format and the undocumented P2 format used only by Eclipse. So, switch the build to use Apache Felix's maven-bundle-plugin. This is the same plugin Jetty uses to produce their OSGi bundle manifests, and is the same plugin used by the Apache Felix project, which is an open-source OSGi runtime. It has a reasonable number of folks using it for production builds, and is running on top of the stable Maven 2.x code base. With this switch we get automatically generated MANIFEST.MF files based on reasonably sane default rules, which reduces the amount of things we have to maintain by hand. When necessary, we can add a few lines of XML to our POMs to tweak the output. Our build artifacts are still fully compatible with Maven 2.x, so any downstream consumers are still able to use our build products, without stepping up to Maven 3.x. Our artifacts are also valid as OSGi bundles, provided they are organized on disk into a repository that the runtime can read. With maven-bundle-plugin the build runs offline, as much as Maven 2.x is able to run offline anyway, so we're able to return to a distributed development environment again. By generating MANIFEST.MF at the top level of each project (and therefore outside of the target directory), we're still compatible with Eclipse's PDE tooling. Our projects can be imported as standard Maven projects using the m2eclipse plugin, but the PDE will think they are vaild plugins and make them available for plugin builds, or while debugging another workbench. This change also completely removes Tycho from the build. Unfortunately, Tycho 0.6.0's pom-first dependency resolver is broken when resolving a pom-first plugin bundle through a manifest-first feature package, so bundle org.eclipse.jgit can't be resolved, even though it might actually exist in the local Maven repository. Rather than fight with Tycho any further, I'm just declaring it plugina-non-grata and ripping it out of the build. Since there are very few tools to build a P2 format repository, and no documentation on how to create one without running the Eclipse UI manually by poking buttons, I'm declaring that we are not going to produce a P2 update site from our automated builds. Change-Id: If7938a86fb0cc8e25099028d832dbd38110b9124 Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
14 years ago
Switch build to Apache Felix maven-bundle-plugin Tycho isn't production ready for projects like JGit to be using as their primary build driver. Some problems we ran into with Tycho 0.6.0 that are preventing us from using it are: * Tycho can't run offline The P2 artifact resolver cannot perform its work offline. If the build system has no network connection, it cannot compile a project through Tycho. This is insane for a distributed version control system where developers are used to being offline during development and local testing. * Magic state in ~/.m2/repository/.meta/p2-metadata.properties Earlier iterations of this patch tried to use a hybrid build, where Tycho was only used for the Eclipse specific feature and P2 update site, and maven-bundle-plugin was used for the other code. This build seemed to work, but only due to magic Tycho specific state held in my local home directory. This means builds are not consistently repeatable across systems, and lead me to believe I had a valid build, when in fact I did not. * Manifest-first build produces incomplete POMs The POM created by the manifest-first build format does not contain the dependency chain, leading a downstream consumer to not import the runtime dependencies necessary to execute the bundle it has imported. In JGit's case, this means JSch isn't included in our dependency chain. * Manifest-first build produces POMs unreadable by Maven 2.x JGit has existing application consumers who are relying on Maven 2.x builds. Forcing them to step up to an alpha release of Maven 3 is simply unacceptable. * OSGi bundle export data management is tedious Editing each of our pom.xml files to mark a new release is difficult enough as it is. Editing every MANIFEST.MF file to list our exported packages and their current version number is something a machine should do, not a human. Yet the Tycho OSGi way unfortunately demands that a human do this work. * OSGi bundle import data management is tedious There isn't a way in the MANIFEST.MF file format to reuse the same version tags across all of our imports, but we want to have a consistent view of our dependencies when we compile JGit. After wasting more than 2 full days trying to get Tycho to work, I've decided its a lost cause right now. We need to be chasing down bugs and critical features, not trying to bridge the gap between the stable Maven repository format and the undocumented P2 format used only by Eclipse. So, switch the build to use Apache Felix's maven-bundle-plugin. This is the same plugin Jetty uses to produce their OSGi bundle manifests, and is the same plugin used by the Apache Felix project, which is an open-source OSGi runtime. It has a reasonable number of folks using it for production builds, and is running on top of the stable Maven 2.x code base. With this switch we get automatically generated MANIFEST.MF files based on reasonably sane default rules, which reduces the amount of things we have to maintain by hand. When necessary, we can add a few lines of XML to our POMs to tweak the output. Our build artifacts are still fully compatible with Maven 2.x, so any downstream consumers are still able to use our build products, without stepping up to Maven 3.x. Our artifacts are also valid as OSGi bundles, provided they are organized on disk into a repository that the runtime can read. With maven-bundle-plugin the build runs offline, as much as Maven 2.x is able to run offline anyway, so we're able to return to a distributed development environment again. By generating MANIFEST.MF at the top level of each project (and therefore outside of the target directory), we're still compatible with Eclipse's PDE tooling. Our projects can be imported as standard Maven projects using the m2eclipse plugin, but the PDE will think they are vaild plugins and make them available for plugin builds, or while debugging another workbench. This change also completely removes Tycho from the build. Unfortunately, Tycho 0.6.0's pom-first dependency resolver is broken when resolving a pom-first plugin bundle through a manifest-first feature package, so bundle org.eclipse.jgit can't be resolved, even though it might actually exist in the local Maven repository. Rather than fight with Tycho any further, I'm just declaring it plugina-non-grata and ripping it out of the build. Since there are very few tools to build a P2 format repository, and no documentation on how to create one without running the Eclipse UI manually by poking buttons, I'm declaring that we are not going to produce a P2 update site from our automated builds. Change-Id: If7938a86fb0cc8e25099028d832dbd38110b9124 Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
14 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. #!/bin/sh
  2. # Copyright (C) 2009, Google Inc.
  3. # and other copyright owners as documented in the project's IP log.
  4. #
  5. # This program and the accompanying materials are made available
  6. # under the terms of the Eclipse Distribution License v1.0 which
  7. # accompanies this distribution, is reproduced below, and is
  8. # available at http://www.eclipse.org/org/documents/edl-v10.php
  9. #
  10. # All rights reserved.
  11. #
  12. # Redistribution and use in source and binary forms, with or
  13. # without modification, are permitted provided that the following
  14. # conditions are met:
  15. #
  16. # - Redistributions of source code must retain the above copyright
  17. # notice, this list of conditions and the following disclaimer.
  18. #
  19. # - Redistributions in binary form must reproduce the above
  20. # copyright notice, this list of conditions and the following
  21. # disclaimer in the documentation and/or other materials provided
  22. # with the distribution.
  23. #
  24. # - Neither the name of the Eclipse Foundation, Inc. nor the
  25. # names of its contributors may be used to endorse or promote
  26. # products derived from this software without specific prior
  27. # written permission.
  28. #
  29. # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  30. # CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  31. # INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. # OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33. # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  34. # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35. # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36. # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37. # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38. # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39. # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40. # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41. # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42. # Update all pom.xml with new build number
  43. #
  44. # TODO(spearce) This should be converted to some sort of
  45. # Java based Maven plugin so its fully portable.
  46. #
  47. case "$1" in
  48. --snapshot=*)
  49. V=$(echo "$1" | perl -pe 's/^--snapshot=//')
  50. if [ -z "$V" ]
  51. then
  52. echo >&2 "usage: $0 --snapshot=0.n.0"
  53. exit 1
  54. fi
  55. case "$V" in
  56. *-SNAPSHOT) : ;;
  57. *) V=$V-SNAPSHOT ;;
  58. esac
  59. ;;
  60. --release)
  61. V=$(git describe HEAD) || exit
  62. ;;
  63. *)
  64. echo >&2 "usage: $0 {--snapshot=0.n.0 | --release}"
  65. exit 1
  66. esac
  67. case "$V" in
  68. v*) V=$(echo "$V" | perl -pe s/^v//) ;;
  69. esac
  70. case "$V" in
  71. *-SNAPSHOT)
  72. POM_V=$V
  73. OSGI_V="${V%%-SNAPSHOT}.qualifier"
  74. ;;
  75. *-[1-9]*-g[0-9a-f]*)
  76. POM_V=$(echo "$V" | perl -pe 's/-(\d+-g.*)$/.$1/')
  77. OSGI_V=$(perl -e '
  78. die unless $ARGV[0] =~ /^(\d+)(?:\.(\d+)(?:\.(\d+))?(?:\.\d{12}-r)?)?-(\d+)-g(.*)$/;
  79. my ($a, $b, $c, $p, $r) = ($1, $2, $3, $4, $5);
  80. $b = '0' unless defined $b;
  81. $c = '0' unless defined $c;
  82. printf "%s.%s.%s.%6.6i_g%s\n", $a, $b, $c, $p, $r;
  83. ' "$V")
  84. ;;
  85. *)
  86. POM_V=$V
  87. OSGI_V=$V
  88. ;;
  89. esac
  90. API_V=$(perl -e '
  91. $ARGV[0] =~ /^(\d+(?:\.\d+(?:\.\d+)?)?)/;
  92. print $1
  93. ' "$V")
  94. API_N=$(perl -e '
  95. $ARGV[0] =~ /^(\d+)(?:\.(\d+)(?:\.(\d+))?)?/;
  96. my ($a, $b) = ($1, $2);
  97. $b = 0 unless defined $b;
  98. $b++;
  99. print "$a.$b.0";
  100. ' "$API_V")
  101. perl -pi~ -e '
  102. s/^(Bundle-Version:\s*).*$/${1}'"$OSGI_V"'/;
  103. s/(org.eclipse.jgit.*;version=")[^"[(]*(")/${1}'"$API_V"'${2}/;
  104. s/(org.eclipse.jgit.*;version="\[)[^"]*(\)")/${1}'"$API_V,$API_N"'${2}/;
  105. ' $(git ls-files | grep META-INF/MANIFEST.MF)
  106. perl -pi~ -e '
  107. s/^(Bundle-Version:\s*).*$/${1}'"$OSGI_V"'/;
  108. s/(org.eclipse.jgit.*;version=")[^"[(]*(")/${1}'"$API_V"'${2}/;
  109. s/(org.eclipse.jgit.*;version="\[)[^"]*(\)")/${1}'"$API_V,$API_N"'${2}/;
  110. s/^(Eclipse-SourceBundle:\s*org.eclipse.jgit.*;version=\").*(\";roots=\"\.\")$/${1}'"$OSGI_V"'${2}/;
  111. ' $(git ls-files | grep META-INF/SOURCE-MANIFEST.MF)
  112. perl -pi~ -e '
  113. if ($ARGV ne $old_argv) {
  114. $seen_version = 0;
  115. $old_argv = $ARGV;
  116. }
  117. if (!$seen_version) {
  118. $seen_version = 1 if (!/<\?xml/ &&
  119. s/(version=")[^"]*(")/${1}'"$OSGI_V"'${2}/);
  120. }
  121. ' org.eclipse.jgit.packaging/org.*.feature/feature.xml
  122. perl -pi~ -e '
  123. if ($ARGV ne $old_argv) {
  124. $seen_version = 0;
  125. $old_argv = $ARGV;
  126. }
  127. if (!$seen_version) {
  128. $seen_version = 1 if
  129. s{<(version)>.*</\1>}{<${1}>'"$POM_V"'</${1}>};
  130. }
  131. ' org.eclipse.jgit.packaging/org.*.feature/pom.xml
  132. perl -pi~ -e '
  133. if ($ARGV ne $old_argv) {
  134. $seen_version = 0;
  135. $old_argv = $ARGV;
  136. }
  137. if ($seen_version < 5) {
  138. $seen_version++ if
  139. s{<(version)>.*</\1>}{<${1}>'"$POM_V"'</${1}>};
  140. }
  141. ' org.eclipse.jgit.packaging/org.eclipse.jgit.updatesite/pom.xml
  142. perl -pi~ -e '
  143. if ($ARGV ne $old_argv) {
  144. $seen_version = 0;
  145. $old_argv = $ARGV;
  146. }
  147. if (!$seen_version) {
  148. $seen_version = 1 if
  149. s{<(version)>.*</\1>}{<${1}>'"$POM_V"'</${1}>};
  150. }
  151. ' org.eclipse.jgit.packaging/pom.xml
  152. perl -pi~ -e '
  153. if ($ARGV ne $old_argv) {
  154. $seen_version = 0;
  155. $old_argv = $ARGV;
  156. }
  157. if (!$seen_version) {
  158. $seen_version = 1 if
  159. s{<(version)>.*</\1>}{<${1}>'"$POM_V"'</${1}>};
  160. }
  161. ' $(git ls-files | grep pom.xml)
  162. find . -name '*~' | xargs rm -f
  163. git diff