[Maven-plugins-cvs] cvs commit: maven-plugins HOWTO_RELEASE.txt

[Jeff J. <jef...@us...>]

jeffjensen    06/04/24 22:19:54

  Added:       .        HOWTO_RELEASE.txt
  Log:
  Add doc of notes on how to release SF plugins.
  
  Revision  Changes    Path
  1.1                  maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  HOW TO RELEASE A MAVEN SOURCEFORGE PLUGIN
  =========================================
  These instructions are for both snapshot and GA releases.
  
  A complete release consists of the program files and the site.
  
  The high-level release steps are:
  1) Deploy the code
  2) Publish the site
  3) Email an announcement
  
  
  PREREQUISITES
  -------------
  Sourceforge requires an SSH key.  The SF account profile has the link to add your public key(s) for access.
  
  
  PRE_RELEASE PREP WORK
  ---------------------
  Update RFEs, bug entries as needed.
  
  Update any developer or contributor info.
  
  Update changes.xml with info (particularly change date of release).
  
  Checkin.
  
  
  DEPLOY RELEASE TO SOURCEFORGE
  -----------------------------
  Follow the notes in the main project.properties file, and override the values (e.g. in your private build.properties).
  For example, put these in it:
  
  maven.repo.maven.plugins.sf.snapshots.username=(your SF id)
  maven.repo.maven.plugins.sf.snapshots.privatekey=(path to private key, e.g. id_rsa file) (if any)
  maven.repo.maven.plugins.sf.snapshots.passphrase=(if your private key has a passphrase)
  
  maven.repo.maven.plugins.sf.releases.username=(your SF id)
  maven.repo.maven.plugins.sf.releases.privatekey=(path to private key, e.g. id_rsa file) (if any)
  maven.repo.maven.plugins.sf.releases.passphrase=(if your private key has a passphrase)
  
  
  Set "maven.repo.list" to the correct deployment location on the command line:
  
  To deploy the snapshot:
  maven -Dmaven.repo.list=maven.plugins.sf.releases plugin:repository-deploy
  
  To deploy the release:
  maven -Dmaven.repo.list=maven.plugins.sf.snapshots plugin:repository-deploy
  
  Appending -SNAPSHOT to the currentVersion will automatically deploy to the snapshot repo.
  
  
  PUBLISH THE SITE TO SOURCEFORGE
  -------------------------------
  Set this in build.properties, or on command line when running:
  maven.username=(your SF id)
  
  Ensure you can ssh to maven-plugins.sourceforge.net without prompts (meaning, your private and public keys are setup correctly).
  This includes accepting the server the first time.
  I had to use this version:
    ssh -l (sfuserid) maven-plugins.sourceforge.net
  instead of
    ssh (sfuserid)@maven-plugins.sourceforge.net
  to get it accepted.
  
  Update bug and feature request entries as needed (e.g. close those completed in the release).
  
  Update and checkin the changes.xml file, including date of release.
  
  Generate site locally and review:
  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site
  
  Then deploy it
  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site:sshdeploy
  
  
  EMAIL RELEASE ANNOUCEMENT
  -------------------------
  The site step generates it, and this is how standalone:
  
  Generate the announcement email:
  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository announcement
  
  Edit it (adjust repos at minimum) and email.