maven-plugins-cvs

[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.
  
  
  

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

[Lukas T. <luk...@us...>]

lukas_theussl    06/04/24 23:10:35

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  Small corrections.
  
  Revision  Changes    Path
  1.2       +8 -5      maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- HOWTO_RELEASE.txt	25 Apr 2006 05:19:54 -0000	1.1
  +++ HOWTO_RELEASE.txt	25 Apr 2006 06:10:35 -0000	1.2
  @@ -43,12 +43,10 @@
   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.
  +To deploy the release:
  +maven -Dmaven.repo.list=maven.plugins.sf.releases plugin:repository-deploy
   
   
   PUBLISH THE SITE TO SOURCEFORGE
  @@ -74,8 +72,13 @@
   Then deploy it
   maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site:sshdeploy
   
  +NOTE: If you are using the maven-site-plugin >= 1.7 you will also have to use -Dmaven.site.failonerror=false.
  +The reason for that is that on the sourceforge server, remote users don't have the right to change the
  +permission for the root site directory (htdocs on sourceforge), so the corresponding chmod command will fail.
  +See http://jira.codehaus.org/browse/MPSITE-34.
  +
   
  -EMAIL RELEASE ANNOUCEMENT
  +EMAIL RELEASE ANNOUNCEMENT
   -------------------------
   The site step generates it, and this is how standalone:
   
  
  
  

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

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

jeffjensen    06/05/13 07:41:56

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  Differentiate snapshot vs release review command for site gen.
  
  Revision  Changes    Path
  1.3       +12 -3     maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- HOWTO_RELEASE.txt	25 Apr 2006 06:10:35 -0000	1.2
  +++ HOWTO_RELEASE.txt	13 May 2006 14:41:56 -0000	1.3
  @@ -67,10 +67,14 @@
   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
  + For snapshot:
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/snapshot-repository site
   
  -Then deploy it
  -maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site:sshdeploy
  + For release:
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site
  +
  +Then deploy it:
  +maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository -Dmaven.site.failonerror=false site:sshdeploy
   
   NOTE: If you are using the maven-site-plugin >= 1.7 you will also have to use -Dmaven.site.failonerror=false.
   The reason for that is that on the sourceforge server, remote users don't have the right to change the
  @@ -86,3 +90,8 @@
   maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository announcement
   
   Edit it (adjust repos at minimum) and email.
  +
  +TAG THE SOURCE
  +--------------
  +cd to the dir containing the project and enter the CVS command:
  +
  
  
  

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

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

jeffjensen    06/06/04 21:41:09

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  Add install plugin section.  Have only first step do clean goal.  Minor typo and formatting changes.
  
  Revision  Changes    Path
  1.5       +16 -6     maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- HOWTO_RELEASE.txt	5 Jun 2006 01:00:22 -0000	1.4
  +++ HOWTO_RELEASE.txt	5 Jun 2006 04:41:09 -0000	1.5
  @@ -15,7 +15,7 @@
   Sourceforge requires an SSH key.  The SF account profile has the link to add your public key(s) for access.
   
   
  -PRE_RELEASE PREP WORK
  +PRE-RELEASE PREP WORK
   ---------------------
   Update RFEs, bug entries as needed.
   
  @@ -26,6 +26,12 @@
   Checkin.
   
   
  +BUILD AND INSTALL THE PLUGIN RELEASE LOCALLY
  +--------------------------------------------
  +The site gen requires its presence.
  + maven clean plugin:install
  +
  +
   DEPLOY RELEASE TO SOURCEFORGE
   -----------------------------
   Follow the notes in the main project.properties file, and override the values (e.g. in your private build.properties).
  @@ -43,10 +49,10 @@
   Set "maven.repo.list" to the correct deployment location on the command line:
   
   To deploy the snapshot:
  -maven -Dmaven.repo.list=maven.plugins.sf.snapshots plugin:repository-deploy
  + maven -Dmaven.repo.list=maven.plugins.sf.snapshots plugin:repository-deploy
   
   To deploy the release:
  -maven -Dmaven.repo.list=maven.plugins.sf.releases plugin:repository-deploy
  + maven -Dmaven.repo.list=maven.plugins.sf.releases plugin:repository-deploy
   
   
   PUBLISH THE SITE TO SOURCEFORGE
  @@ -68,13 +74,17 @@
   
   Generate site locally and review:
    For snapshot:
  -  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/snapshot-repository clean site
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/snapshot-repository site
   
    For release:
  -  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository clean site
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site
  +
  + If the plugin project depends on a Maven snapshot plugin (including itself),
  + add the CVS repo to the repo property:
  +   -Dmaven.repo.remote=http://www.ibiblio.org/maven,http://cvs.apache.org/repository/
   
   Then deploy it:
  -maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository -Dmaven.site.failonerror=false site:sshdeploy
  + maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository -Dmaven.site.failonerror=false site:sshdeploy
   
   NOTE: If you are using the maven-site-plugin >= 1.7 you will also have to use -Dmaven.site.failonerror=false.
   The reason for that is that on the sourceforge server, remote users don't have the right to change the
  
  
  

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

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

jeffjensen    06/06/04 18:00:22

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  Add "clean" to suggested commands.
  
  Revision  Changes    Path
  1.4       +2 -2      maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- HOWTO_RELEASE.txt	13 May 2006 14:41:56 -0000	1.3
  +++ HOWTO_RELEASE.txt	5 Jun 2006 01:00:22 -0000	1.4
  @@ -68,10 +68,10 @@
   
   Generate site locally and review:
    For snapshot:
  -  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/snapshot-repository site
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/snapshot-repository clean site
   
    For release:
  -  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository site
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository clean site
   
   Then deploy it:
   maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository -Dmaven.site.failonerror=false site:sshdeploy
  
  
  

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

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

jeffjensen    07/01/28 06:08:49

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  Add step to add SF news item.  Tweak steps order.
  
  Revision  Changes    Path
  1.6       +10 -5     maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- HOWTO_RELEASE.txt	5 Jun 2006 04:41:09 -0000	1.5
  +++ HOWTO_RELEASE.txt	28 Jan 2007 14:08:49 -0000	1.6
  @@ -92,6 +92,16 @@
   See http://jira.codehaus.org/browse/MPSITE-34.
   
   
  +TAG THE SOURCE
  +--------------
  +cd to the dir containing the project and enter the CVS command:
  +
  +
  +ADD SOURCEFORGE NEWS ITEM
  +-------------------------
  +Use the admin facility to add one, announcing the release.
  +
  +
   EMAIL RELEASE ANNOUNCEMENT
   -------------------------
   The site step generates it, and this is how standalone:
  @@ -100,8 +110,3 @@
   maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository announcement
   
   Edit it (adjust repos at minimum) and email.
  -
  -TAG THE SOURCE
  ---------------
  -cd to the dir containing the project and enter the CVS command:
  -
  
  
  

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

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

jeffjensen    07/05/11 19:33:06

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  add tip.
  
  Revision  Changes    Path
  1.7       +4 -0      maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- HOWTO_RELEASE.txt	28 Jan 2007 14:08:49 -0000	1.6
  +++ HOWTO_RELEASE.txt	12 May 2007 02:33:05 -0000	1.7
  @@ -54,6 +54,10 @@
   To deploy the release:
    maven -Dmaven.repo.list=maven.plugins.sf.releases plugin:repository-deploy
   
  +TIP: When "strange/unknown" build failures occur,
  +sometimes fixing any problems with "maven site" (error messages are more apparent)
  +first magically fixes the deploy issues (e.g. missing <version> info).
  +
   
   PUBLISH THE SITE TO SOURCEFORGE
   -------------------------------
  
  
  

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

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

jeffjensen    07/05/29 19:59:47

  Modified:    .        HOWTO_RELEASE.txt
  Log:
  Add notes on full SF site deploy.
  
  Revision  Changes    Path
  1.8       +12 -2     maven-plugins/HOWTO_RELEASE.txt
  
  Index: HOWTO_RELEASE.txt
  ===================================================================
  RCS file: /cvsroot/maven-plugins/maven-plugins/HOWTO_RELEASE.txt,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- HOWTO_RELEASE.txt	12 May 2007 02:33:05 -0000	1.7
  +++ HOWTO_RELEASE.txt	30 May 2007 02:59:47 -0000	1.8
  @@ -59,8 +59,8 @@
   first magically fixes the deploy issues (e.g. missing <version> info).
   
   
  -PUBLISH THE SITE TO SOURCEFORGE
  --------------------------------
  +PUBLISH THE RELEASE'S SITE TO SOURCEFORGE
  +-----------------------------------------
   Set this in build.properties, or on command line when running:
   maven.username=(your SF id)
   
  @@ -114,3 +114,13 @@
   maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository announcement
   
   Edit it (adjust repos at minimum) and email.
  +
  +
  +PUBLISHING THE ENTIRE SF SITE
  +-----------------------------
  +From the top level dir:
  +1. Build site locally and review:
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository multiproject:site
  +
  +2. Deploy it:
  +  maven -Dmaven.repo.remote=http://maven-plugins.sourceforge.net/repository -Dmaven.site.failonerror=false multiproject:site-deploy