source: tags/1.8.0/doc/releng.org

* ABCL Release Engineering 

See also <https://abcl.org/trac/wiki/ReleaseSteps>.

*** Maven

Instructions for releasing ABCL on Sonatype's OSS Maven repository.

You need a Sonatype account, see
<https://central.sonatype.org/pages/ossrh-guide.html>.  This will
result in providing you with a "JIRA username and a password".

**** settings.xml

Enter your "JIRA username and a password" in a
<file:.m2/settings.xml>.  This will be used for authentication when
the =mvn= tool uploads artifacts to the Sonatype snapshot and staging
infrastructure.

#+BEGIN_SRC xml
<settings>
 <server>
   <id>sonatype-nexus-snapshots</id>
   <username>sonatype-jira-username</username>
   <password>sonatype-jira-password</password>
 </server>
 <server>
   <id>sonatype-nexus-staging</id>
   <username>sonatype-jira-username</username>
   <password>sonatype-jira-password</password>
 </server>
</settings>
#+END_SRC

**** Process

Ensure that the artifacts you wish to upload are present by building
them.
#+begin_src 
ant abcl.release abcl.source.jar abcl.javadoc.jar abcl.contrib.javadoc.jar abcl.contrib.source.jar
#+end_src

#+BEGIN_SRC 
ant abcl.jar abcl.source.jar abcl.javadoc.jar abcl.contrib
#+END_SRC

And maybe test it as well

#+BEGIN_SRC 
ant abcl.test
#+END_SRC

**** Snapshots
For snapshots (aka development versions) the version in the POM should
be of the form ~x.y.z-SNAPSHOT~.

#+BEGIN_SRC bash
keyname='<your_pgp_key@example.com>'
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl.jar -DpomFile=pom.xml -Durl=https://oss.sonatype.org/content/repositories/snapshots/ -DrepositoryId=sonatype-nexus-snapshots
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-sources.jar -DpomFile=pom.xml -Durl=https://oss.sonatype.org/content/repositories/snapshots/ -DrepositoryId=sonatype-nexus-snapshots -Dclassifier=sources
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-javadoc.jar -DpomFile=pom.xml -Durl=https://oss.sonatype.org/content/repositories/snapshots/ -DrepositoryId=sonatype-nexus-snapshots -Dclassifier=javadoc
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-contrib.jar -DpomFile=contrib/pom.xml -Durl=https://oss.sonatype.org/content/repositories/snapshots/ -DrepositoryId=sonatype-nexus-snapshots 
#+END_SRC

**** Release
For releases the version in the POM should be of the form  ~x.y.z~

#+BEGIN_SRC bash
keyname='<your_pgg_key@example.com>'
abcl_version=1.8.0
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl.jar -DpomFile=pom.xml -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-${abcl_version}-sources.jar -DpomFile=pom.xml -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -Dclassifier=sources
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-${abcl_version}-javadoc.jar -DpomFile=pom.xml -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -Dclassifier=javadoc
#+END_SRC

abcl-contrib release

#+BEGIN_SRC bash
keyname='<evenson.not.org@gmail.com>'
abcl_version=1.8.0
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-contrib.jar -DpomFile=contrib/pom.xml -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging 
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-contrib-${abcl_version}-sources.jar -DpomFile=contrib/pom.xml -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -Dclassifier=sources
mvn gpg:sign-and-deploy-file -Dgpg.keyname=${keyname} -Dfile=dist/abcl-contrib-${abcl_version}-javadoc.jar -DpomFile=contrib/pom.xml -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging -Dclassifier=javadoc
#+END_SRC

**** Releasing through Sonatype interface
<https://www.sonatype.org/nexus/2015/06/02/how-to-publish-software-artifacts-to-maven-central/>
<https://central.sonatype.org/pages/releasing-the-deployment.html>

1. "Close" the repo

2. wait

3. "Release" the repo

**** Testing downloads 

#+BEGIN_SRC 
mvn org.apache.maven.plugins:maven-dependency-plugin:2.1:get -DrepoUrl=https://oss.sonatype.org/content/repositories/snapshots -Dartifact=org.abcl:abcl-contrib:1.5.0-SNAPSHOT:jar
#+END_SRC



*** Specifying GPG executable

For specifying the =gpg= executable used via =mvn= use a property
specified via the =gpg.executable= property (e.g. '-Dgpg.executable=gpg2'.)

**** Signing binary release

gpg --default-key YOUR-KEY --detach-sign --armor FILE

#+begin_src bash
key="evenson.not.org@gmail.com"
for file in *; do gpg --default-key ${key} --detach-sign --armor ${file} ; done
#+end_src

** Update CLiki page
<https://www.cliki.net/ABCL>
Roswell parses it for release information?

* Colophon
  
  #+begin_example
  Created: ??
  Revised: <2020-10-21 Wed 10:01>
  #+end_example