build-release-pkgs.xml

<!--
   Copyright The Narayana Authors
   SPDX short identifier: Apache-2.0
 -->

<!--
    build-release-pkgs.xml: Utility script for building Narayana release artifacts.
    Probably only useful for Narayana dev team. Everyone else should only need the
    regular build.xml.

    This script automates the some steps of the release build and packaging process
    to reduce the opportunities for users to get it wrong. For example, it works from
    a fresh git checkout to ensure locally modified files in a dev's git working copy
    don't sneak into the release bundle.

    usage:

      Tag the Narayana release on GitHub.
        or you can do a snapshot release direct from main, see properties below.

      Check the version of WildFly referenced in pom.xml is sane.
        In general, use the oldest WildFly release the Narayana release is intended to support.

      Update the properties section below to suit your machine.

      Set JAVA_HOME to a jdk 1.8, since that's the version we currently support.
      Set the host used to rsync to (-Drsync.host=<fully qualified hostname>).

      ant -f build-release-pkgs.xml -Drsync.host=${RSYNC_HOST} all

      rsync or sftp the downloads to publish to the web site (careful with the trailing '/') e.g.
        rsync -avz 4.11.0.Final jbosstm@<rsync host>:downloads_htdocs/jbosstm/

      Check out Narayana web page. This script uploas all the contents to the develop branch.
      However, you have to execute awestruct build as explained in web page's readme.

      Update appropriate wiki pages, such as the 'which version to use' page.
        http://community.jboss.org/wiki/JBossTransactionsVersionGuide

      Then login to https://repository.jboss.org/nexus/ and publish the artifacts.

      This version is for Narayana 5.0.4 onwards. Don't use it for earlier releases, they are structured differently.
-->
<project name="Narayana Release Packaging" default="fail" basedir=".">
  <description>
        package Narayana binary + src files for upload to website and other repos.
    </description>
  <!-- the fully qualified name of the host to use for rsync'ing artefacts (such as zips and website) during the build -->
  <property name="rsync.host" value="${rsync.host}"/>
  <property name="awestruct.executable" value="awestruct"/>
  <!-- where to get the source -->
  <property name="gitbase" value="git@github.com:jbosstm"/>
  <!-- The tag as it appears under svnbase -->
  <property name="tag" value="7.0.2.Final-SNAPSHOT"/>
  <!-- a working directory for the process. Can contain output from previous releases if you like to keep them archived locally. -->
  <property name="workdir" location="${user.home}/tmp/narayana/${tag}"/>
  <!-- the location the Narayana web site downloads are copied to -->
  <property name="downloads.dir" value="downloads_htdocs/jbosstm/"/>
  <!-- the location the Narayana web site downloads are copied to -->
  <property name="docs.dir" value="docs_htdocs/jbosstm/"/>
  <!-- you probably don't need to change anything below here -->
  <taskdef resource="net/sf/antcontrib/antlib.xml">
    <classpath>
      <pathelement location="./antbuildsystem/ant-contrib-1.0b3.jar"/>
    </classpath>
  </taskdef>
  <target name="fail">
    <fail message="you must specify a target"/>
  </target>
  <target name="all" depends="init,downloads,web"/>
  <target name="init">
    <tstamp/>
    <fail message="You must set a workdir">
      <condition>
        <not>
          <isset property="workdir"/>
        </not>
      </condition>
    </fail>
    <fail message="You cannot perform a build without a clone in ${workdir}/sources/*/">
      <condition>
        <not>
          <available file="${workdir}/sources/" type="dir"/>
        </not>
      </condition>
    </fail>
  </target> 
  <target name="downloads" description="copy release bundles to Narayana web site storage">
    <delete dir="${workdir}/downloads/"/>
    <mkdir dir="${workdir}/downloads/"/>
    <mkdir dir="${workdir}/downloads/src"/>
    <mkdir dir="${workdir}/downloads/binary"/>
    <mkdir dir="${workdir}/downloads/idl"/>
    <copy todir="${workdir}/downloads/src">
      <fileset dir="${workdir}" includes="narayana-*-${tag}-src.zip"/>
    </copy>
    <copy todir="${workdir}/downloads/binary">
      <fileset dir="${workdir}/sources/narayana/narayana-full/target/" includes="narayana-full-${tag}-bin.zip"/>
    </copy>
    <copy todir="${workdir}/downloads/idl">
      <fileset dir="${workdir}/sources/narayana/ArjunaJTS/idl/src/main/idl/arjuna">
        <include name="ArjunaOTS.idl"/>
      </fileset>
    </copy>
    <copy todir="${workdir}/downloads/idl">
      <fileset dir="${workdir}/sources/narayana/ArjunaJTS/idl/src/main/idl/omg">
        <include name="CosTransactions.idl"/>
        <include name="XA.idl"/>
      </fileset>
    </copy>
    <copy file="${workdir}/sources/narayana/narayana-full/target/narayana-full-${tag}-javadoc.jar" todir="${workdir}/downloads/api"/>
    <antcall target="rsync.downloads"/>
  </target>

  <target name="rsync.downloads" if="${rsync.enabled}">
    <exec executable="bash" dir="${workdir}" failonerror="true">
      <arg value="-c"/>
      <arg value="rsync --chmod=ugo=rwX --partial --progress --rsh=ssh -r downloads/* jbosstm@{rsync.host}:${downloads.dir}/${tag}" />
    </exec>
  </target>
  
  <target name="web" description="Update downloads, docs, and javadocs on Narayana web page and commit them">
    <!-- Check out web page development branch -->
    <delete dir="${workdir}/narayana.io"/>
    <exec executable="git" dir="${workdir}">
      <arg value="clone"/>
      <arg value="${gitbase}/narayana.io.git"/>
    </exec>
    <exec executable="git" dir="${workdir}/narayana.io">
      <arg value="checkout"/>
      <arg value="develop"/>
    </exec>
    
    <!-- Update web page content -->
    <antcall target="web-downloads"/>
    <antcall target="web-docs"/>
    <antcall target="web-api"/>
    
    <!-- Commit web page changes -->
    <exec executable="git" dir="${workdir}/narayana.io/">
      <arg value="add"/>
      <arg value="--all"/>
    </exec>
    <exec executable="git" dir="${workdir}/narayana.io/">
      <arg value="commit"/>
      <arg value="-m"/>
      <arg value="Updated Narayana to ${tag}"/>
    </exec>
    <exec executable="git" dir="${workdir}/narayana.io/">
      <arg value="push"/>
      <arg value="origin"/>
      <arg value="develop"/>
    </exec>

    <!-- We no longer build automatically web pages, nor push automatically to the file server to jboss.org -->
    <!-- To manually update the website follow the instructions in README (https://github.com/jbosstm/narayana.io/blob/develop/README.md) -->
  
  <target name="web-docs" depends="docs.check" if="docs.exist" description="Update documentations on Narayana web page">
    <delete dir="${workdir}/narayana.io/docs/product"/>
    <delete dir="${workdir}/narayana.io/docs/project"/>
    <mkdir dir="${workdir}/narayana.io/docs/product"/>
    <mkdir dir="${workdir}/narayana.io/docs/project"/>
    <copy todir="${workdir}/narayana.io/docs/product">
      <fileset dir="${workdir}/sources/documentation/product/target/docbook/publish/en-US/html_single"/>
    </copy>
    <copy todir="${workdir}/narayana.io/docs/project">
      <fileset dir="${workdir}/sources/documentation/project/target/docbook/publish/en-US/html_single"/>
    </copy>
  </target>
  
  <target name="web-downloads" depends="downloads.check" if="downloads.exist" description="Update downloads on Narayana web page">
    <tstamp>
      <format property="date" pattern="yyyy-MM-dd"/>
    </tstamp>
    
    <!-- Create new current Narayana release configuration -->
    <delete file="${workdir}/narayana.io/_config/current_narayana_release.yml"/>
    <touch file="${workdir}/narayana.io/_config/current_narayana_release.yml"/>
    <echo file="${workdir}/narayana.io/_config/current_narayana_release.yml">version: ${tag}
date: ${date}
binary: http://www.jboss.org/jbosstm/downloads/${tag}/binary/narayana-full-${tag}-bin.zip
source: http://www.jboss.org/jbosstm/downloads/${tag}/src/narayana-full-${tag}-src.zip
    </echo>
  </target>
  
  <target name="web-api" depends="api.check" if="api.exist" description="Update javadocs on Narayana web page">
    <!-- Update javadoc htmls on the page -->
    <delete dir="${workdir}/narayana.io/docs/api/"/>
    <delete dir="${workdir}/narayana.io/docs/jatmibroker-xatmi-api/"/>
    <delete dir="${workdir}/narayana.io/docs/jatmibroker-nbf-api/"/>
    <unzip src="${workdir}/downloads/api/narayana-full-${tag}-javadoc.jar" dest="${workdir}/narayana.io/docs/api"/>

    <!-- Update javadocs download url -->
    <exec executable="sed" dir="${workdir}/narayana.io/_config/" outputproperty="first-api-line">
      <arg value="q"/>
      <arg value="current_narayana_api.yml"/>
    </exec>
    <echo file="${workdir}/narayana.io/_config/current_narayana_api.yml">${first-api-line}
download: http://www.jboss.org/jbosstm/downloads/${tag}/api/narayana-full-${tag}-javadoc.jar</echo>
  </target>
  
  <target name="docs.check" description="Check if documentations were built">
    <condition property="docs.exist">
      <available file="${workdir}/sources/documentation" type="dir"/>
    </condition>
  </target>
  
  <target name="downloads.check" description="Check if downloads were built">
    <condition property="downloads.exist">
      <available file="${workdir}/downloads" type="dir"/>
    </condition>
  </target>
  
  <target name="api.check" description="Check if javadocs were built">
    <condition property="api.exist">
      <available file="${workdir}/downloads/api/narayana-full-${tag}-javadoc.jar"/>
    </condition>
  </target>

</project>