UI-Component Sets
Project Documentation

MyFaces 2.3.x Release Checklist (Developer Info)

Wikis to follow as guides:

Checklist of tasks to perform for each release. For general information about Apache releases you may also consult Publishing Maven Artifacts.


NOTE: Make sure you have the right ssh public key set in id.apache.org page before performing the release steps.

Before performing the release you need to configure your environment if you haven't done it before.

a. Go to: Publishing Maven Artifacts
b. Go to the section SETUP YOUR DEVELOPMENT ENVIRONMENT and generate the pgp key signature. Don't forget to distribute the public key step.
Link: Generate PGP signature

NOTE: You can ignore sections GETTING YOUR PROJECT SETUP IN THE NEXUS REPOSITORY and MAVEN SPECIFIC PREPARATIONS AND PROCEDURES but reading the whole document will help you understand the release process. Also, we don't need to setup the project in nexus repository by creating a JIRA issue.

Some useful links/resources:

1. Preparing shared 4.2.9 (optional)

    NOTE: This step is optional. The current project structure does not required a "shared project" release, since it just copy the code inside the shared module in myfaces core.

  • Change shared/core/pom.xml variable to mirror updated shared copy from core and run from shared root path
  • mvn clean install -Dsynch-shared=true
    Try -DdryRun=true SUCCESS
    mvn release:prepare -DtagBase=https://svn.apache.org/repos/asf/myfaces/shared/tags -DdryRun=true    
    Release it! FAIL
    mvn release:prepare -DtagBase=https://svn.apache.org/repos/asf/myfaces/shared/tags -Dresume=false
    mvn install
    mvn release:rollback
    mvn release:prepare -DtagBase=https://svn.apache.org/repos/asf/myfaces/shared/tags -Dresume=false

    NOTE: Preparing the release will create the new tag in SVN, automatically checking in on your behalf. Note: If you're located in Europe then release:prepare may fail with 'Unable to tag SCM' and 'svn: No such revision X'. Wait 10 seconds and run mvn release:prepare again.

  • Stage the release for a vote

  • mvn release:perform -DtagBase=https://svn.apache.org/repos/asf/myfaces/shared/tags

2. Preparing Core 2.3.0

  • Once the environment is configured, run the following commands to prepare the MyFaces Core

  • mvn clean install
    mvn install -Pgenerate-assembly -Papache-release
    # The dryRun=true don't checkin or tag anything in the scm repository, or modify the checkout. 
    # Useful to check modifications to poms and scm operations.
    mvn release:prepare -DprepareRelease=true -DdryRun=true
    # Run again this command to prepare release 
    # and commit to https://svn.apache.org/repos/asf/myfaces/core/tags/ repository.
    mvn release:prepare -DprepareRelease=true -Dresume=false 

    NOTE: Preparing the release will create the new tag in SVN, automatically checking in on your behalf.

    NOTE: If you're located in Europe then release:prepare may fail with 'Unable to tag SCM' and 'svn: No such revision X'. Wait 10 seconds and run mvn release:prepare again.

    NOTE: If you see a message like "You don't have a SNAPSHOT project in the reactor projects list" it means that the workspace directory is not cleaned and Maven uses the old temporary files which contain some weird versions instead of the current SNAPSHOTs. You will have to do a mvn release:clean or start the process again from the beginning. Maven no snapshot in the project

  • Verify that the new tag myfaces-core-module-2.3.0 was created: MyFaces Core Tags

  • You should be able to checkout myfaces-core-module-2.3.0 and run: mvn install

  • Stage the release for a vote

  • # Finally perform the release so artifacts are uploaded to nexus repository.
    mvn release:perform -DperformRelease=true

Some useful links/resources:

3. JIRA Release Management

  • Create 2.3.1 and 2.3.1-SNAPSHOT versions
  • Find resolved issues and close them
  • Unresolved issues moved to 2.3.1-SNAPSHOT

Go to the following link perform these steps under the MyFaces Core Project: JIRA Dashboard

4. TCK

  • We can skip TCK step if there is no TCK for JSF 2.3

5. Generate assembly

  • Automatically done by maven on release:perform step and should be available in the nexus maven repository to do the final deploy.
  • Login to nexus repository using the id.apache.org account: Nexus Repository

    Now under Build Promotion go to Staging Repositories, look for orgapachemyfaces-xxxx repository. Click "close" so the artifacts can be downloaded. If the artifacts has some bug you can click "drop", if the artifacts are approved, you can click on "release".

    More information here: Locate and examine your staging repository

    Link: https://repository.apache.org/content/repositories/orgapachemyfaces-1130/org/apache/myfaces/core/myfaces-core-assembly/2.3.0/

  • Otherwise you can generate them manually. Try to do it automatically javadoc and other stuff SUCCESS. It generate myfaces-core-2.3.0-bin.tar.gz and zip
  • mvn install -Pgenerate-assembly
    cd assembly
    mvn package
  • Create myfaces-core-2.3.0-src.tar.gz and zip manually and create .asc .sha1 for bin and src
  • openssl sha1 myfaces-core-2.3.0-src.tar.gz > myfaces-core-2.3.0-src.tar.gz.sha1
    openssl sha1 myfaces-core-2.3.0-src.zip > myfaces-core-2.3.0-src.zip.sha1
    gpg --armor --output myfaces-core-2.3.0-src.tar.gz.asc --detach-sig myfaces-core-2.3.0-src.tar.gz
    gpg --armor --output myfaces-core-2.3.0-src.zip.asc --detach-sig myfaces-core-2.3.0-src.zip
    openssl sha1 myfaces-core-2.3.0-bin.tar.gz > myfaces-core-2.3.0-bin.tar.gz.sha1
    openssl sha1 myfaces-core-2.3.0-bin.zip > myfaces-core-2.3.0-bin.zip.sha1
    gpg --armor --output myfaces-core-2.3.0-bin.tar.gz.asc --detach-sig myfaces-core-2.3.0-bin.tar.gz
    gpg --armor --output myfaces-core-2.3.0-bin.zip.asc --detach-sig myfaces-core-2.3.0-bin.zip
  • Copy to ftp private account on people.apache.org
  • scp -p -r myfaces-core-2.3.0-bin* embreijo@people.apache.org:/home/embreijo/public_html/myfaces230binsrc/binaries
    scp -p -r myfaces-core-2.3.0-src* embreijo@people.apache.org:/home/embreijo/public_html/myfaces230binsrc/sources

6. Clirr report to check binary incompatibilities success

    NOTE: I could not use the Clirr tool but I was able to use a similar tool called japicmp

    Github: https://github.com/siom79/japicmp
    Website: https://siom79.github.io/japicmp/

  • Download the jar-with-dependencies.jar archive and follow instructions to compare the two versions.
  • Example: java -jar japicmp-0.11.0-jar-with-dependencies.jar -n <v2_binary>.jar -o <v1_binary>.jar --ignore-missing-classes --html-file <dir_name>/results.html

    Report of myfaces-api-2.3.0-beta vs myfaces-api-2.3.0.jar looks good.

7. VOTE: Send email to the MyFaces DEV - dev@myfaces.apache.org

    Subject: [VOTE] release of MyFaces Core 2.3.0
    I was running the needed tasks to get the 2.3.0 release of Apache
    MyFaces core out.
    Please note that this vote concerns all of the following parts:
       1. Maven artifact group "org.apache.myfaces.core" v2.3.0  [1]
    The artifacts were deployed on nexus repo [1] for binary and source packages.
    The release notes could be found at [4].
    Also the japicmp tool (similar to clirr) does not show binary incompatibilities with myfaces-api.
    Please take a look at the "2.3.0" artifacts and vote! (see [3])
    Please note: This vote is "majority approval" with a minimum of three +1 votes (see [2]).
    [ ] +1 for community members who have reviewed the bits
    [ ] +0
    [ ] -1 for fatal flaws that should cause these bits not to be released, and why..............
    Eduardo M. Breijo
    [1] https://repository.apache.org/content/repositories/orgapachemyfaces-1130/org/apache/myfaces/core/
    [2] http://www.apache.org/foundation/voting.html#ReleaseVotes
    [3] https://repository.apache.org/content/repositories/orgapachemyfaces-1130/org/apache/myfaces/core/myfaces-core-assembly/
    [4] https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=10600&version=12339569

    NOTE: To generate the ReleaseNote you need to go to the JIRA dashboard. Then go to MyFaces Core project. Finally go to the version to be released (example 2.3.0) and click "Release Notes" button.

8. Vote closed, starting distribution

9. Site deploy for shared and core (mvn site:site and mvn site:deploy)

10. Announce

  • Sent announcement mail

  • To: announce@apache.org, announce@myfaces.apache.org
    Cc: dev@myfaces.apache.org, users@myfaces.apache.org
  • Sent announcement to jcp-open@apache.org (Necessary for TCK certified releases)

  • Subject: [ANNOUNCE] MyFaces Core v2.3.0 Release
    The Apache MyFaces team is pleased to announce the release of MyFaces Core 2.3.0.
    MyFaces Core is a JavaServer(tm) Faces 2.3 implementation as specified by JSR-372.
    MyFaces Core 2.3.0 is available in both binary and source distributions.
        * http://myfaces.apache.org/download.html
    MyFaces Core is also available in the central Maven repository under Group ID "org.apache.myfaces.core".
    Release Notes - MyFaces Core - Version 2.3.0 can be found in the following link: 
    Eduardo M. Breijo