Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. In JIRA, "release" the version, setting the date to the end-of-vote date. Visit the "Administer Project" page, then the "Manage versions" page. You need to have the "Admin" role in HADOOP, HDFS, MAPREDUCE, and YARN.
  2. Set environment variable version for later steps. export version=X.Y.Z
  3. Tag the release. Do it from the release branch and push the created tag to the remote repository:

    No Format
    git tag -s rel/release-${version} -m "Hadoop ${version} release"
    git push origin rel/release-${version}
    


  4. Copy release files to the distribution directory
    1. Check out the corresponding svn repo if need be

      No Format
      svn co https://dist.apache.org/repos/dist/release/hadoop/common/ hadoop-dist
      


    2. Copy the release files to hadoop-dist/hadoop-${version}
    3. Update the symlinks to current2 and stable2. The release directory usually contains just two releases, the most recent from two branches.
    4. Commit the changes (it requires a PMC privilege)

      No Format
      svn ci -m "Publishing the bits for release ${version}"
      


    5. Usually binary tarball becomes larger than 300MB, so it cannot be directly uploaded to the distribution directory. Use the dev directory (https://dist.apache.org/repos/dist/dev/hadoop/) first and then move it to the distribution directory by svn move.
  5. Update upstream branches to make them aware of this new release:
    1. Copy and commit the CHANGELOG.md and RELEASENOTES.md:

      No Format
       cp target/artifacts/RELEASENOTES.md hadoop-common-project/hadoop-common/src/site/markdown/release/${version}/RELEASENOTES.${version}.md
       cp target/artifacts/CHANGELOG.md hadoop-common-project/hadoop-common/src/site/markdown/release/${version}/CHANGELOG.${version}.md
      


    2. Copy the jdiff xml files for this version to their appropriate directory.

      No Format
        cp hadoop-common-project/hadoop-common/target/site/jdiff/xml/Apache_Hadoop_Common_${version}.xml hadoop-common-project/hadoop-common/dev-support/jdiff
        cp hadoop-hdfs-project/hadoop-hdfs/target/site/jdiff/xml/Apache_Hadoop_HDFS_${version}.xml hadoop-hdfs-project/hadoop-hdfs/dev-support/jdiff
        find hadoop-yarn-project -name "Apache_Hadoop_YARN_*_${version}.xml" | xargs -I{} cp {} hadoop-yarn-project/hadoop-yarn/dev-support/jdiff
        find hadoop-mapreduce-project -name "Apache_Hadoop_MapReduce_*_${version}.xml" | xargs -I{} cp {} hadoop-mapreduce-project/dev-support/jdiff


    3. Update hadoop-project-dist/pom.xml

      No Format
       <jdiff.stable.api>X.Y.Z</jdiff.stable.api>
      


  6. In Nexus
    1. effect the release of artifacts by selecting the staged repository and then clicking Release
    2. If there were multiple RCs, simply drop the staging repositories corresponding to failed RCs.
  7. Wait 24 hours for release to propagate to mirrors.
  8. Edit the website (Generic docs about the new website generation can be found [here|https://cwiki.apache.org/confluence/display/HADOOP/How+to+generate+and+push+ASF+web+site+after+HADOOP-14163)
    1. Checkout the website if you haven't already

      No Format
      git clone https://gitbox.apache.org/repos/asf/hadoop-site.git -b asf-site
        


    2. Install hugo if you haven't already ((tldr; apt-get install/pacman -S/brew install hugo))
    3. Create the new release announcement (Set environment variable version first. export VERSION=X.Y.Z).

      No Format
      cat << EOF > src/release/${VERSION}.md
      ---
      title: Release ${VERSION} available
      date: 202X-XX-XX
      linked: true
      ---
      <!---
        Licensed under the Apache License, Version 2.0 (the "License");
        you may not use this file except in compliance with the License.
        You may obtain a copy of the License at
      
         http://www.apache.org/licenses/LICENSE-2.0
      
        Unless required by applicable law or agreed to in writing, software
        distributed under the License is distributed on an "AS IS" BASIS,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        See the License for the specific language governing permissions and
        limitations under the License. See accompanying LICENSE file.
      -->
      
      This is the first stable release of Apache Hadoop TODO line.
      
      It contains TODO bug fixes, improvements and enhancements since TODO.
      
      Users are encouraged to read the [overview of major changes][1] since TODO.
      For details of TODO bug fixes, improvements, and other enhancements since the previous TODO release, 
      please check [release notes][2] and [changelog][3].
      
      [1]: /docs/r${VERSION}/index.html
      [2]: http://hadoop.apache.org/docs/r${VERSION}/hadoop-project-dist/hadoop-common/release/${VERSION}/RELEASENOTES.${VERSION}.html
      [3]: http://hadoop.apache.org/docs/r${VERSION}/hadoop-project-dist/hadoop-common/release/${VERSION}/CHANGELOG.${VERSION}.html
      
      EOF
        


    4. Note: update all the TODO + the date. Don't use date from the future, it won't be rendered.
    5. Remove the linked: true line from the previous release file, eg. from src/release/3.0.0.md. Docs/downloads of the releases with linked:true will be linked from the menu.
    6. add the docs and update the content/docs/current link, by doing the following:

      No Format
      cd content/docs
      tar xvf /path/to/hadoop-${version}-site.tar.gz
      # Update current2, current, stable and stable2 as needed.
      # For example
      rm current2 current
      ln -s r${version} current2
      ln -s current2 current
      


    7. Similarly update the symlinks for stable if need be.
    8. Check the rendering of the new site: hugo serve && firefox http://localhost:1313
    9. Regenerate the site, review it, then commit it per the instructions in HowToCommit. (The generated HTML files also should be committed. Both src and the rendered site are in the same repo.)

      No Format
      hugo
      git add .
      git commit
      git push
      


  9. Send announcements to the user and developer lists once the site changes are visible. Optionally on Hadoop-PMC owned twitter account @hadoop. (For password reach out to private@)
  10. In JIRA, close issues resolved in the release. Disable mail notifications for this bulk change. Recommend not closing, since it prevents JIRAs from being edited and makes it more difficult to track backports.
  11. Add the release in "Apache Committee Report Helper" for the next board report to pick that up automatically at https://reporter.apache.org/addrelease.html?hadoop (Requires PMC member rights)

...