Skip to content
This repository has been archived by the owner on Nov 17, 2017. It is now read-only.

Latest commit

 

History

History
70 lines (51 loc) · 4.5 KB

howto-release.adoc

File metadata and controls

70 lines (51 loc) · 4.5 KB
Raw

Release Process

This guide provides a chronological steps which goes through release tagging, and publishing. Every RichFaces 4.5.x release is tested both automatically (i.e. Jenkins runs Selenium test suite) and manually in chosen web browsers. All release Jenkins jobs can be found in Release tab on Jenkins.

Prerequisites

You need to make sure you have access to the internal JBoss QA nexus server, with permissions to release. The documents above have information on this, but if you are not sure please contact JBoss helpdesk, and follow up with the project lead.

Release settings

Before beginning any of the procedures below you need to setup your maven installation.

Use following template for a release-settings.xml and pass it to all Maven executions (just change username, password and localRepository settings as convenient):

<settings>
    <localRepository>/path/to/repository/you/can/write/to</localRepository>

    <mirrors>
        <mirror>
            <id>jboss-staging-repository-group</id>
            <mirrorOf>!jboss-qa-releases,!jboss-public-repository-group,central</mirrorOf>
            <name>JBoss.org Staging Repository Group</name>
            <url>https://origin-repository.jboss.org/nexus/content/groups/staging/</url>
        </mirror>
    </mirrors>

    <servers>
        <server>
            <id>jboss-qa-releases</id>
            <username>{your_username}</username>
            <password>{your_password}</password>
        </server>
    </servers>

</settings>

Using these settings you will use separated local repository which will be populated only with artifacts from JBoss Staging repository and released artifacts. That way you can verify that the build is reproducible using JBoss Maven repositories.

Nexus Information

Once the release is done and Nexus’s Staging repository for given release is closed (published), the bits are available through JBoss Staging repository. They are waiting there for verification and promotion to JBoss Releases repository. In the case of needed respin, broken RichFaces bits are removed from the staging repository.

First Steps

QE team lead will create a JIRA task in project RFPL for testing release containing subtasks for each member of team. The parent task and its subtask need to have "QE" component set. The easiest way is to clone QE release task from latest release, e.g. RFPL-3375. Fix version and task summary need to be changed manually in both parent task and all subtasks. The umbrella JIRA task should be linked to this QE task. Sub tasks should be self-describing or should contain details about what needs to be tested.

Releasing Functional Test Suite

  1. Verify that you are able to commit to RichFaces QA repository.

  2. Verify that you are able to upload artifacts to Nexus QA (setup and check setting.xml) - you have to setup credentials for repository with id jboss-qa-releases

    1. see the settings.xml example on the top of this document

  3. Clone the git repository.

    1. git clone git@github.com:richfaces/richfaces-qa.git

  4. Update RichFaces version from snapshot to release version and push to Github.

    1. Usually the release.sh script would fail if there are snapshot dependencies.

    2. Exceptionally, it is possible to add -DignoreSnapshots=true to the CONF variable in release.sh script.

  5. Run release script.

    1. First, script will ask you if the specified version of RichFaces is correct.

    2. Then the release script will ask for tests release version. Use timestamp format, e.g. `4.5.0.20140716-Alpha3 `.

    3. Then the release script will ask for new development version, use next suitable snapshot, e.g. 4.5.1-SNAPSHOT.

    4. At the end the release script will ask for path to your settings.xml file, use path to the file prepared in step 2.1.

  6. Follow the instructions (press ENTER) to go through all the steps: clean, dry run, clean, prepare, perform.

  7. After prepare, the tag is created. You should see the tag on Github at this moment.

  8. After perform, the artifacts are released to Nexus QA repository.

  9. After release, change RichFaces version back to snapshot and push changes to Github.