You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hbase.apache.org by "Andrew Purtell (JIRA)" <ji...@apache.org> on 2018/10/19 20:06:00 UTC

[jira] [Comment Edited] (HBASE-21346) Update release procedure and website publishing docs in the book

    [ https://issues.apache.org/jira/browse/HBASE-21346?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16657346#comment-16657346 ] 

Andrew Purtell edited comment on HBASE-21346 at 10/19/18 8:05 PM:
------------------------------------------------------------------

Here is what I'm testing for the downloads table update:

The downloads table entry has this format. Entries in the table should be sorted by version in descending order. Substitute for $VERSION and $RELEASE_DATE.
{noformat}
    <tr>
      <td style="test-align: left">
        $VERSION
      </td>
      <td style="test-align: left">
        $RELEASE_DATE
      </td>
      <td style="test-align: left">
        <a href="https://apache.org/dist/hbase/$RELEASE/compat-check-report.html">Compatibility check report</a>
      </td>
      <td style="test-align: left">
        <a href="https://github.com/apache/hbase/blob/rel/$VERSION/CHANGES.txt">Changes</a>
      </td>
      <td style="test-align: left">
        <a href="https://s.apache.org/hbase-$VERSION-jira-release-notes">Release Notes</a>
      </td>
      <td style="test-align: left">
        <a href="https://www.apache.org/dyn/closer.lua/hbase/$VERSION/hbase-$VERSION-src.tar.gz">src</a> (<a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.sha512">sha512</a> <a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.asc">asc</a>) <br />
        <a href="https://www.apache.org/dyn/closer.lua/hbase/$VERSION/hbase-$VERSION-bin.tar.gz">bin</a> (<a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.sha512">sha512</a> <a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.asc">asc</a>)
      </td>
    </tr>
{noformat}
Prerequistes for a new entry:
 * Generate a compatiblity report against the prior release and place it in dist such that it is available at [https://apache.org/dist/hbase/$RELEASE/compat-check-report.html]

 * Create a tag for the release and push it up as rel/$VERSION.

 * Create a named short link to the JIRA release notes using s.apache.org: [https://s.apache.org/hbase-$VERSION-jira-release-notes]

 * Place the release binaries and signatures into dist such that the are available at

            Sources
   
            [https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz]
            [https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.asc|https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.sha512] 
            [https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.sha512]

            Binaries

            [https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz]
            [https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.asc]
            [https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.sha512]


When all prerequsities are in place, update src/site/xdoc/downloads.xml on master branch, add the new table entry, and push master up. A Jenkins job will build the site and deploy it. Wait for the new site to be published.


was (Author: apurtell):
Here is what I'm testing for the downloads table update:

The downloads table entry has this format. Entries in the table should be sorted by version in descending order. Substitute for $VERSION and $RELEASE_DATE.
{noformat}
    <tr>
      <td style="test-align: left">
        $VERSION
      </td>
      <td style="test-align: left">
        $RELEASE_DATE
      </td>
      <td style="test-align: left">
        <a href="https://apache.org/dist/hbase/$RELEASE/compat-check-report.html">Compatibility check report</a>
      </td>
      <td style="test-align: left">
        <a href="https://github.com/apache/hbase/blob/rel/$VERSION/CHANGES.txt">Changes</a>
      </td>
      <td style="test-align: left">
        <a href="https://s.apache.org/hbase-$VERSION-jira-release-notes">Release Notes</a>
      </td>
      <td style="test-align: left">
        <a href="https://www.apache.org/dyn/closer.lua/hbase/$VERSION/hbase-$VERSION-src.tar.gz">src</a> (<a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.sha512">sha512</a> <a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.asc">asc</a>) <br />
        <a href="https://www.apache.org/dyn/closer.lua/hbase/$VERSION/hbase-$VERSION-bin.tar.gz">bin</a> (<a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.sha512">sha512</a> <a href="https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.asc">asc</a>)
      </td>
    </tr>
{noformat}


Prerequistes for a new entry:
 * Generate a compatiblity report against the prior release and place it in dist such that it is available at [https://apache.org/dist/hbase/$RELEASE/compat-check-report.html]

 * Create a tag for the release and push it up as rel/$VERSION.

 * Create a named short link to the JIRA release notes using s.apache.org: [https://s.apache.org/hbase-$VERSION-jira-release-notes]

 * Place the release binaries and signatures into dist such that the are available at

    Sources
  
    https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz
    https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-src.tar.gz.sha512

    Binaries

    https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz
    https://apache.org/dist/hbase/$VERSION/hbase-$VERSION-bin.tar.gz.sha512


When all prerequsities are in place, update src/site/xdoc/downloads.xml on master branch, add the new table entry, and push master up. A Jenkins job will build the site and deploy it. Wait for the new site to be published.

> Update release procedure and website publishing docs in the book
> ----------------------------------------------------------------
>
>                 Key: HBASE-21346
>                 URL: https://issues.apache.org/jira/browse/HBASE-21346
>             Project: HBase
>          Issue Type: Task
>          Components: documentation, website
>            Reporter: Andrew Purtell
>            Assignee: Andrew Purtell
>            Priority: Major
>
> Now as part of the release process the RM must manually update the download page (hbase.apache.org/downloads/). To accomplish that [~mdrob] says
> {quote}
> To update the download links, on master branch edit
>  src/site/xdoc/downloads.xml
>  After you commit and push, jenkins will build the site and publish it for you.
> {quote}
>  
> New code lines also need a fork of the API documentation. To accomplish that:
> {quote}
> To update the API Docs and version specific reference guide, update src/site/site.xml with a new section to link to the docs in the drop down list. (only necessary the first time, but it hasn't been done yet for 1.4.x) Then git clone [https://git-wip-us.apache.org/repos/asf/hbase-site.git] and make a 1.4 directory there. Copy contents of the docs/ directory from the release tarball to the version directory. Copy target/site/devapidocs and testapidocs from a local build of the tag, since those don't get published in the release tarball. Commit your changes, then do an empty commit with message "INFRA-10751 Empty commit". Push your changes
> {quote}
>  
> Try this out. Take notes. Update the release instructions and website publish instructions in the book accordingly.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)