You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by ri...@apache.org on 2015/07/31 13:54:15 UTC
svn commit: r1693576 [5/6] - in /incubator/brooklyn/site:
developers/committers/ developers/committers/release-process/
documentation/ download/ learnmore/catalog/ meta/
Added: incubator/brooklyn/site/developers/committers/release-process/release-version.html
URL: http://svn.apache.org/viewvc/incubator/brooklyn/site/developers/committers/release-process/release-version.html?rev=1693576&view=auto
==============================================================================
--- incubator/brooklyn/site/developers/committers/release-process/release-version.html (added)
+++ incubator/brooklyn/site/developers/committers/release-process/release-version.html Fri Jul 31 11:54:14 2015
@@ -0,0 +1,811 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+-->
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+
+
+<head>
+
+
+<title>Release branch and set version - Apache Brooklyn (incubating)</title>
+
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+
+<link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">
+<link href="/style/deps/octicons/octicons.css" rel="stylesheet">
+<link href="/style/deps/bootstrap-theme.css" rel="stylesheet">
+
+<link rel="stylesheet" href="/style/css/code.css" type="text/css" media="screen" />
+
+<link href="/style/css/website.css" rel="stylesheet">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+<script src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
+<script type="text/javascript" src="/style/deps/jquery.cookie.js"></script>
+
+
+</head>
+
+
+<body>
+
+<nav class="navbar navbar-default navbar-fixed-top" id="header" role="navigation">
+ <div class="container-and-sidebars">
+
+ <div class="container-sidebar-left feather">
+ <a href="http://www.apache.org/">
+ <img src="/style/img/feather.png" alt="[Apache]" width="80" class="flip navbar-feather">
+ </a>
+ </div>
+
+ <div class="container container-between-sidebars top-menu">
+ <div class="container-fluid">
+ <!-- Brand and toggle get grouped for better mobile display -->
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/"><img src="/style/img/apache-brooklyn-logo-244px-wide.png" alt="brooklyn"></a>
+ </div>
+
+ <!-- Collect the nav links, forms, and other content for toggling -->
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right">
+
+
+ <li class="dropdown">
+ <a href="/learnmore/index.html">learn more</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/learnmore/index.html">Learn More</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/learnmore/blueprint-tour.html">Blueprint Tour
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/learnmore/features/index.html">Features
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/learnmore/theory.html">Theory
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/learnmore/catalog/index.html">Browse Catalog
+ </a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+
+ <li class="">
+ <a href="/download/index.html">download</a>
+ </li>
+
+
+
+ <li class="">
+ <a href="/v/latest/start/running.html">get started</a>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="/documentation/index.html">documentation</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/documentation/index.html">Documentation</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/v/latest/index.html">User Guide
+ </a>
+
+ <div class="dropdown_section_header"><hr></div>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/yaml/creating-yaml.html">YAML Blueprints
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/java/index.html">Java Blueprints
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/ops/index.html">Operations
+ </a>
+
+ <div class="dropdown_section_header"><hr></div>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/dev/index.html">Developer Guide
+ </a>
+
+ </li>
+
+ <li>
+
+ <div class="dropdown_new_section"><hr></div>
+
+ <a href="/documentation/other-docs.html">Other Resources
+ </a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="/community/index.html">community</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/community/index.html">Community</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/community/mailing-lists.html">Mailing Lists
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/community/irc.html">IRC
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
+ <span class="octicon octicon-link-external"></span></a>
+
+ </li>
+
+ <li>
+
+ <a href="/community/how-to-contribute-docs.html">How to Contribute Documentation
+ </a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown active">
+ <a href="/developers/index.html">developers</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/developers/index.html">Developers</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/developers/how-to-contribute.html">How to Contribute
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/dev/index.html">Developer Guide
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/developers/committers/index.html">Committer Guide
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/developers/code-standards.html">Code Standards
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="http://github.com/apache/incubator-brooklyn">GitHub
+ <span class="octicon octicon-link-external"></span></a>
+
+ </li>
+
+ <li>
+
+ <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
+ <span class="octicon octicon-link-external"></span></a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+ </ul>
+ </div><!-- /.navbar-collapse -->
+ </div><!-- /.container-fluid -->
+ </div><!-- /.container -->
+
+ <div class="container-sidebar-right">
+ <div class="navbar-sidebar-right-icons">
+ <a href="https://github.com/apache/incubator-brooklyn" class="navbar-icon navbar-icon-shift icon-github"
+ data-toggle="tooltip" data-placement="bottom" title="GitHub: apache/incubator-brooklyn"/>
+ <a href="https://twitter.com/#!/search?q=brooklyncentral" class="navbar-icon navbar-icon-shift icon-twitter"
+ data-toggle="tooltip" data-placement="bottom" title="Twitter: @brooklyncentral"/>
+ <a href="http://webchat.freenode.net/?channels=brooklyncentral" class="navbar-icon icon-irc"
+ data-toggle="tooltip" data-placement="bottom" title="IRC: freenode #brooklyncentral"/>
+ <!-- extra a element seems needed as landing page seems to copy the last element here (!?)
+ -->
+ <a href="/" style="width: 0px; height: 0px;"></a>
+ </div>
+ </div>
+
+ </div>
+</nav>
+
+
+<div class="container" id="main_container">
+ <div class="row">
+ <div class="col-md-9" id="content_container">
+ <div id="page_notes"></div>
+ <h1>Release branch and set version</h1>
+ <p>This will allow development to continue on master without affecting the release; it also allows quick-fixes to the
+release branch to address last-minute problems (which must of course be merged/cherry-picked back into master later).</p>
+
+<p>Determine the correct name for the version. Note that while in incubation, we must include âincubatingâ in our release
+name - common practice for this is to append â-incubatingâ to the release version.</p>
+
+<p>Do not use -rc1, -rc2 etc. in version strings. Use the version that will be the actual published version. (The artifacts
+that get uploaded to the dist.apache.org/dev will include â-rc1â etc. in the folder name, but the contents will be <em>as
+final</em>. Therefore, turning the rc into the final is simply a case of taking the rc file and publishing it to the release
+folder with the correct name.)</p>
+
+<p>References:
+- <a href="https://mail-archives.apache.org/mod_mbox/incubator-general/201409.mbox/%3CCAK2iWdS1H9dkJcSdohky6hFqJdP0XyuhAG%2B%3D1Aspxcjt5RmnJw%40mail.gmail.com%3E">Post on general@incubator</a>
+- <a href="https://mail-archives.apache.org/mod_mbox/incubator-general/201409.mbox/%3CCAOGo0VaEz4cEUbgMgqhh3hiiiubnspiGkQ%3DQv08bOwPqRtzAvQ%40mail.gmail.com%3E">Post on general@incubator</a></p>
+
+<h2 id="create-the-release-branch-and-set-the-release-version-number">Create the release branch and set the release version number</h2>
+
+<p>Create a branch with the same name as the version, based off master:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">git checkout master
+git pull --rebase <span class="c"># assumes that the Apache canonical repository is the default upstream for your master - amend if necessary</span>
+git checkout -b <span class="nv">$VERSION_NAME</span>
+git push -u apache <span class="nv">$VERSION_NAME</span></code></pre></div>
+
+<p>Now change the version numbers throughout the repository using the script <code>release/change-version.sh</code>.</p>
+
+<p>Example:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">./release/change-version.sh BROOKLYN <span class="nv">$OLD_MASTER_VERSION</span> <span class="nv">$VERSION_NAME</span>
+git add .
+<span class="c"># Now inspect the staged changes and ensure there are no surprises</span>
+git commit -m <span class="s2">"Change version to $VERSION_NAME"</span>
+git push</code></pre></div>
+
+<h2 id="update-the-version-on-master">Update the version on master</h2>
+
+<p>The <code>master</code> branch will now need updating to refer to the next planned version. (This step is not required if making
+a âmilestoneâ release or similar.)</p>
+
+<p>Example:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">git checkout master
+./release/change-version.sh BROOKLYN <span class="nv">$OLD_MASTER_VERSION</span> <span class="nv">$NEW_MASTER_VERSION</span>
+git add .
+<span class="c"># Now inspect the staged changes and ensure there are no surprises</span>
+git commit -m <span class="s2">"Change version to $NEW_MASTER_VERSION"</span>
+git push</code></pre></div>
+
+<h2 id="switch-back-to-the-release-branch">Switch back to the release branch</h2>
+
+<p>Move back to the release branch:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">git checkout <span class="nv">$VERSION_NAME</span></code></pre></div>
+
+
+ </div>
+
+ <div class="col-md-3">
+ <div class="list-group side-menu" id="side-menu">
+
+
+
+
+
+
+ <h4 class=" with_following">
+ <a href="/developers/index.html" class="list-group-item breadcrumb breadcrumb0">
+ Developers
+ </a></h4>
+
+ <h4 class=" with_preceding with_following">
+ <a href="/developers/committers/index.html" class="list-group-item breadcrumb breadcrumb1">
+ Committer Guide
+ </a></h4>
+
+ <h4 class=" with_preceding">
+ <a href="/developers/committers/release-process/index.html" class="list-group-item breadcrumb breadcrumb2">
+ Release Process
+ </a></h4>
+
+
+
+
+
+ <a href="/developers/committers/release-process/prerequisites.html" class="list-group-item">Release Prerequisites
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/environment-variables.html" class="list-group-item">Environment variables for the release
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/release-version.html" class="list-group-item active">Release branch and set version
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/make-release-artifacts.html" class="list-group-item">Make the release artifacts
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/verify-release-artifacts.html" class="list-group-item">Verify the release artifacts
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/publish-temp.html" class="list-group-item">Publish to the staging area
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/vote.html" class="list-group-item">Vote on dev@brooklyn
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/fix-release.html" class="list-group-item">Fix on the release branch
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/vote-ipmc.html" class="list-group-item">Vote on general@incubator
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/publish.html" class="list-group-item">Publish to the public
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/announce.html" class="list-group-item">Announce the release
+ </a>
+
+
+
+
+
+
+
+</div>
+<div id="width_reference"></div>
+
+
+<script language="JavaScript" type="application/javascript">
+
+
+sidemenu_x_sizer=function(){ $('#side-menu').width($('#side-menu').parent().find('#width_reference').outerWidth()); };
+$(sidemenu_x_sizer);
+$(window).resize(sidemenu_x_sizer);
+
+
+sidemenu_y_nonfloater=function(){
+ if ($('#side-menu').outerHeight(true) + $('#header').outerHeight(true) + $('#footer').outerHeight(true) > window.innerHeight ||
+ $('#side-menu').width() >= $('#content_container').width()/2) {
+ $('#side-menu').css('position', 'inherit');
+ } else {
+ // restore if screen has grown
+ $('#side-menu').css('position', 'fixed');
+ }
+};
+$(sidemenu_y_nonfloater);
+$(window).resize(sidemenu_y_nonfloater);
+
+
+
+var sideMenu = $("#side-menu"),
+ sideItems = sideMenu.find("a"),
+ // Anchors corresponding to menu items
+ scrollItems = sideItems.map(function(){
+ var item = $(this).attr("section-target");
+ if (item && item.length) { return item; }
+ });
+
+var highlight_section_last_top = -1;
+var highlight_section_completed = false;
+
+var highlight_section = function() {
+ // Get container scroll position
+ var highlight_section_new_top = $(this).scrollTop();
+ if (highlight_section_new_top == highlight_section_last_top) return;
+ var highlight_section_new_bottom = highlight_section_new_top + $(window).height();
+ var scroll_advancing = (highlight_section_new_top > highlight_section_last_top);
+
+ var last_item = null, active_item = $("#side-menu a.section#active");
+
+ var found_top = false;
+ var displayable_items = scrollItems.map(function(itemI){
+ item = $(scrollItems[itemI]);
+ if (item && item.length) {
+ if (highlight_section_last_top == -1 || !highlight_section_completed) {
+ // just opening page - take item matching hash, or otherwise the first item visible
+ if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 20 && !found_top)) {
+ found_top = true;
+ if (item.selector === window.location.hash && item.offset().top < highlight_section_new_top + 60) {
+ // because of our top header, we need to scroll 64px down from any link
+ $('html, body').animate({scrollTop: item.offset().top - 64}, 0);
+ }
+ return item;
+ }
+ } else if (scroll_advancing) {
+ // if scrolling advance, pick up a section when title starts before 1/3 height
+ if (item.offset().top < highlight_section_new_top + $(window).height()/3)
+ return item;
+
+ // or if containing div is finished (usu the whole main content)
+ div_containing_item = item.closest("div");
+ if (div_containing_item.offset().top + div_containing_item.height() < highlight_section_new_bottom + 15)
+ return item;
+ // or when next title is visible
+ if (last_item && item.offset().top < highlight_section_new_bottom + 15)
+ return last_item;
+ } else {
+ // if scrolling back, pick up a section as soon as the title is visible,
+ if (item.offset().top < highlight_section_new_top)
+ return item;
+ // or if title is before the 2/3 point
+ // (not sure about this, probably want also to have
+ // "AND the id.top is <= displayable_itemsrent_active_it.top" so we don't jump FORWARD a section
+ // when scrolling BACK, with lots of tiny sections)
+ if ((item.offset().top < highlight_section_new_top + 2*$(window).height()/3)
+ && (!active_item || !active_item.offset() || active_item.offset().top >= item.offset().top))
+ return item;
+
+ }
+ last_item = item;
+ }
+ });
+ if (!highlight_section_completed && document.readyState === "complete") {
+ highlight_section_completed = true;
+ }
+ if (!displayable_items.length) {
+ $("#side-menu a.section").removeClass("active");
+ } else {
+ displayable_items = displayable_items[displayable_items.length-1];
+ var id = displayable_items && displayable_items.length ? displayable_items[0].id : "";
+ // Set/remove active class
+ new_active = $("#side-menu a.section").filter("[section-target='#"+id+"']");
+ if (new_active.hasClass("active")) {
+ // nothing needed
+ } else {
+ $("#side-menu a.section").removeClass("active");
+ $("#side-menu a.section").filter("[section-target='#"+id+"']").addClass("active");
+ }
+ }
+
+ highlight_section_last_top = highlight_section_new_top;
+};
+var highlight_new_section = function() {
+ highlight_section_completed = false;
+ highlight_section_last_top = -1;
+ highlight_section();
+}
+
+$(window).scroll(highlight_section);
+$(highlight_new_section);
+
+// detect link change - courtesy http://www.bennadel.com/blog/1520-binding-events-to-non-dom-objects-with-jquery.htm
+ (
+ function( $ ){
+ // Default to the current location.
+ var strLocation = window.location.href;
+ var strHash = window.location.hash;
+ var strPrevLocation = "";
+ var strPrevHash = "";
+
+ // This is how often we will be checkint for
+ // changes on the location.
+ var intIntervalTime = 100;
+
+ // This method removes the pound from the hash.
+ var fnCleanHash = function( strHash ){
+ return(
+ strHash.substring( 1, strHash.length )
+ );
+ }
+
+ // This will be the method that we use to check
+ // changes in the window location.
+ var fnCheckLocation = function(){
+ // Check to see if the location has changed.
+ if (strLocation != window.location.href){
+
+ // Store the new and previous locations.
+ strPrevLocation = strLocation;
+ strPrevHash = strHash;
+ strLocation = window.location.href;
+ strHash = window.location.hash;
+
+ // The location has changed. Trigger a
+ // change event on the location object,
+ // passing in the current and previous
+ // location values.
+ $( window.location ).trigger(
+ "change",
+ {
+ currentHref: strLocation,
+ currentHash: fnCleanHash( strHash ),
+ previousHref: strPrevLocation,
+ previousHash: fnCleanHash( strPrevHash )
+ }
+ );
+
+ }
+ }
+
+ // Set an interval to check the location changes.
+ setInterval( fnCheckLocation, intIntervalTime );
+ }
+ )( jQuery );
+// and trigger highlight section on link change
+$(window.location).bind("change", highlight_new_section);
+
+</script>
+
+ </div>
+ </div>
+</div>
+
+<div id="footer">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-10 text-muted">
+ Apache Brooklyn is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
+ License v2.0</a>.
+ <br />
+ Apache Brooklyn is currently undergoing Incubation at The Apache Software
+ Foundation.
+ </div>
+ <div class="col-md-2">
+ <a class="btn btn-sm btn-default" href="https://github.com/apache/incubator-brooklyn/edit/master/docs/website/developers/committers/release-process/release-version.md">Edit This Page</a>
+ <a href="https://brooklyn.incubator.apache.org/community/how-to-contribute-docs.html"
+ data-toggle="tooltip" data-placement="top" title="How to Edit Documentation" data-delay="400"/>
+ <span class="octicon octicon-question octicon-footer"></span>
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+<script src="//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.min.js"></script>
+
+<script language="JavaScript" type="application/javascript">
+ fix_padding_function = function () {
+ $('body').css('padding-top', parseInt($('#header').css("height"))+10);
+ $('body').css('padding-bottom', parseInt($('#footer').css("height"))+10);
+ };
+ $(window).resize(fix_padding_function);
+ $(window).load(fix_padding_function);
+
+ $(function () {
+ $('[data-toggle="tooltip"]').tooltip({ delay: { show: 600, hide: 100 }})
+ });
+
+/* generate anchors for headers, a la github and http://blog.parkermoore.de/2014/08/01/header-anchor-links-in-vanilla-javascript-for-github-pages-and-jekyll/ */
+var anchorForId = function (id, text) {
+ var anchor = document.createElement("a");
+ anchor.className = "header-link";
+ anchor.href = "#" + id;
+ anchor.innerHTML = "<i class=\"fa fa-link\"></i>";
+ return anchor;
+};
+
+var linkifyAnchors = function (level, containingElement) {
+ var headers = contentBlock.find("h" + level);
+ for (var h = 0; h < headers.length; h++) {
+ var header = headers[h];
+ if (typeof header.id !== "undefined" && header.id !== "") {
+ header.appendChild(anchorForId(header.id, $(header).text()));
+ }
+ }
+};
+
+$(function () {
+ contentBlock = $("#content_container");
+ if (!contentBlock) return;
+ for (var level = 1; level <= 6; level++) {
+ linkifyAnchors(level, contentBlock);
+ }
+});
+
+<!-- Clipboard support -->
+ ZeroClipboard.config({ moviePath: '//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.swf' });
+
+$(function() {
+ $('div.highlight').prepend(
+ $('<div class="clipboard_container" title="Copy to Clipboard">'+
+ '<div class="fa clipboard_button">'+
+ '<div class="on-active"><div>Copied to Clipboard</div></div>'+
+ '</div></div>'));
+ $('div.clipboard_container').each(function(index) {
+ var clipboard = new ZeroClipboard();
+ clipboard.clip( $(this).find(":first")[0], $(this)[0] );
+ var target = $(this).next();
+ var txt = target.text().trim();
+ if (target.find('code.bash')) {
+ // Strip out bash prompts from the start of each line (i.e. '$' or '%' characters
+ // at the very start, or immediately following any newline). Correctly handles continuation
+ // lines, where a leading '$' or '%' is *not* a prompt character.
+ txt = txt.replace(/(^|[^\\]\n)[$%] /g, "$1");
+ }
+ clipboard.on( 'dataRequested', function (client, args) {
+ client.setText( txt );
+ });
+ });
+});
+
+<!-- search -->
+ $(function() {
+ $('#simple_google')
+ .submit(function() {
+ $('input[name="q"]').val("site:" + document.location.hostname + " " + $('input[name="brooklyn-search"]').val());
+ return true;
+ });
+ $('input[name="brooklyn-search"]').focus(function() {
+ if ($(this).val() === $(this).attr('placeholder')) {
+ $(this).val('');
+ }
+ })
+ .blur(function() {
+ if ($(this).val() === '') {
+ $(this).val($(this).attr('placeholder'));
+ }
+ })
+ .blur();
+ });
+
+
+ <!-- analytics -->
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-30530918-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+
+<!-- page warning (for archive pages) -->
+
+
+ function get_user_versions() {
+ return $.cookie("brooklyn_versions") ? $.cookie("brooklyn_versions").split(",") : [];
+ };
+ function set_user_version(version) {
+ var version_cookie = get_user_versions();
+ version_cookie.push(version);
+ $.cookie('brooklyn_versions', version_cookie, { expires: 365, path: '/' });
+ $('#page_notes').fadeOut();
+ event.preventDefault ? event.preventDefault() : event.returnValue = false;
+ };
+ function set_user_versions_all() {
+ var version_cookie = get_user_versions();
+ version_cookie.push("ALL");
+ $.cookie('brooklyn_versions', version_cookie, { expires: 365, path: '/' });
+ $('#page_notes').fadeOut();
+ event.preventDefault ? event.preventDefault() : event.returnValue = false;
+ };
+ function clear_user_versions() {
+ $.removeCookie('brooklyn_versions', { path: '/' });
+ $('#page_notes').fadeIn('slow');
+ event.preventDefault ? event.preventDefault() : event.returnValue = false;
+ };
+
+</script>
+
+</body>
+
+</html>
Added: incubator/brooklyn/site/developers/committers/release-process/verify-release-artifacts.html
URL: http://svn.apache.org/viewvc/incubator/brooklyn/site/developers/committers/release-process/verify-release-artifacts.html?rev=1693576&view=auto
==============================================================================
--- incubator/brooklyn/site/developers/committers/release-process/verify-release-artifacts.html (added)
+++ incubator/brooklyn/site/developers/committers/release-process/verify-release-artifacts.html Fri Jul 31 11:54:14 2015
@@ -0,0 +1,882 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+-->
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+
+
+<head>
+
+
+<title>Verify the release artifacts - Apache Brooklyn (incubating)</title>
+
+<meta http-equiv="content-type" content="text/html; charset=utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+
+<link href="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css" rel="stylesheet">
+<link href="/style/deps/octicons/octicons.css" rel="stylesheet">
+<link href="/style/deps/bootstrap-theme.css" rel="stylesheet">
+
+<link rel="stylesheet" href="/style/css/code.css" type="text/css" media="screen" />
+
+<link href="/style/css/website.css" rel="stylesheet">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+<script src="https://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
+<script type="text/javascript" src="/style/deps/jquery.cookie.js"></script>
+
+
+</head>
+
+
+<body>
+
+<nav class="navbar navbar-default navbar-fixed-top" id="header" role="navigation">
+ <div class="container-and-sidebars">
+
+ <div class="container-sidebar-left feather">
+ <a href="http://www.apache.org/">
+ <img src="/style/img/feather.png" alt="[Apache]" width="80" class="flip navbar-feather">
+ </a>
+ </div>
+
+ <div class="container container-between-sidebars top-menu">
+ <div class="container-fluid">
+ <!-- Brand and toggle get grouped for better mobile display -->
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/"><img src="/style/img/apache-brooklyn-logo-244px-wide.png" alt="brooklyn"></a>
+ </div>
+
+ <!-- Collect the nav links, forms, and other content for toggling -->
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right">
+
+
+ <li class="dropdown">
+ <a href="/learnmore/index.html">learn more</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/learnmore/index.html">Learn More</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/learnmore/blueprint-tour.html">Blueprint Tour
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/learnmore/features/index.html">Features
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/learnmore/theory.html">Theory
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/learnmore/catalog/index.html">Browse Catalog
+ </a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+
+ <li class="">
+ <a href="/download/index.html">download</a>
+ </li>
+
+
+
+ <li class="">
+ <a href="/v/latest/start/running.html">get started</a>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="/documentation/index.html">documentation</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/documentation/index.html">Documentation</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/v/latest/index.html">User Guide
+ </a>
+
+ <div class="dropdown_section_header"><hr></div>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/yaml/creating-yaml.html">YAML Blueprints
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/java/index.html">Java Blueprints
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/ops/index.html">Operations
+ </a>
+
+ <div class="dropdown_section_header"><hr></div>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/dev/index.html">Developer Guide
+ </a>
+
+ </li>
+
+ <li>
+
+ <div class="dropdown_new_section"><hr></div>
+
+ <a href="/documentation/other-docs.html">Other Resources
+ </a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown">
+ <a href="/community/index.html">community</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/community/index.html">Community</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/community/mailing-lists.html">Mailing Lists
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/community/irc.html">IRC
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
+ <span class="octicon octicon-link-external"></span></a>
+
+ </li>
+
+ <li>
+
+ <a href="/community/how-to-contribute-docs.html">How to Contribute Documentation
+ </a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+
+ <li class="dropdown active">
+ <a href="/developers/index.html">developers</a>
+ <ul class="dropdown-menu" role="menu">
+ <li>
+ <a href="/developers/index.html">Developers</a>
+ </li>
+ <li class="divider"></li>
+
+ <li>
+
+ <a href="/developers/how-to-contribute.html">How to Contribute
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/v/latest/dev/index.html">Developer Guide
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/developers/committers/index.html">Committer Guide
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="/developers/code-standards.html">Code Standards
+ </a>
+
+ </li>
+
+ <li>
+
+ <a href="http://github.com/apache/incubator-brooklyn">GitHub
+ <span class="octicon octicon-link-external"></span></a>
+
+ </li>
+
+ <li>
+
+ <a href="https://issues.apache.org/jira/browse/BROOKLYN">Bug Tracker (JIRA)
+ <span class="octicon octicon-link-external"></span></a>
+
+ </li>
+
+ </ul>
+ </li>
+
+
+ </ul>
+ </div><!-- /.navbar-collapse -->
+ </div><!-- /.container-fluid -->
+ </div><!-- /.container -->
+
+ <div class="container-sidebar-right">
+ <div class="navbar-sidebar-right-icons">
+ <a href="https://github.com/apache/incubator-brooklyn" class="navbar-icon navbar-icon-shift icon-github"
+ data-toggle="tooltip" data-placement="bottom" title="GitHub: apache/incubator-brooklyn"/>
+ <a href="https://twitter.com/#!/search?q=brooklyncentral" class="navbar-icon navbar-icon-shift icon-twitter"
+ data-toggle="tooltip" data-placement="bottom" title="Twitter: @brooklyncentral"/>
+ <a href="http://webchat.freenode.net/?channels=brooklyncentral" class="navbar-icon icon-irc"
+ data-toggle="tooltip" data-placement="bottom" title="IRC: freenode #brooklyncentral"/>
+ <!-- extra a element seems needed as landing page seems to copy the last element here (!?)
+ -->
+ <a href="/" style="width: 0px; height: 0px;"></a>
+ </div>
+ </div>
+
+ </div>
+</nav>
+
+
+<div class="container" id="main_container">
+ <div class="row">
+ <div class="col-md-9" id="content_container">
+ <div id="page_notes"></div>
+ <h1>Verify the release artifacts</h1>
+ <p>Below is described a series of âsanity checksâ that should be performed before uploading the artifacts to the
+pre-release area. They are also useful for community members that want to check the artifact before voting (community
+members may also want to check the <a href="prerequisites.html#software-packages">list of required software packages</a> to ensure
+they have the GnuPG and md5sum/sha1sum installed.</p>
+
+<h2 id="setup">Setup</h2>
+
+<p>The scripts below use several environment variables to cut out repetition and enable easy repeatability for the next
+release. You should determine the following information and set your environment:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="c"># The version we are releasing now. While Brooklyn is in the Apache Incubator, this must be suffixed `-incubating`.</span>
+<span class="nv">VERSION_NAME</span><span class="o">=</span>0.7.0-incubating
+
+<span class="c"># The release candidate number we are making now.</span>
+<span class="nv">RC_NUMBER</span><span class="o">=</span>1
+
+<span class="c"># A reference to your Git repository for Brooklyn</span>
+<span class="nv">BASE_REPO</span><span class="o">=</span>~/repos/apache-asf/incubator-brooklyn
+
+<span class="c"># The Git commit hash from which the release was made - get this from the release script, or the Release Manager's announcement</span>
+<span class="nv">GIT_COMMIT</span><span class="o">=</span>edcf928ee65cc29a84376c822759e468a9f016fe</code></pre></div>
+
+<p>Import the PGP keys of the release Managers:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash">curl https://dist.apache.org/repos/dist/release/incubator/brooklyn/KEYS <span class="p">|</span> gpg2 --import</code></pre></div>
+
+<h2 id="verify-the-hashes-and-signatures-of-artifacts">Verify the hashes and signatures of artifacts</h2>
+
+<p>If the releases have been published to the pre-release area, download them:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">TEMP_DIR</span><span class="o">=</span>~/tmp/brooklyn/release/<span class="k">${</span><span class="nv">VERSION_NAME</span><span class="k">}</span>-rc<span class="k">${</span><span class="nv">RC_NUMBER</span><span class="k">}</span>
+<span class="nv">BASE_NAME</span><span class="o">=</span>apache-brooklyn-<span class="k">${</span><span class="nv">VERSION_NAME</span><span class="k">}</span>-rc<span class="k">${</span><span class="nv">RC_NUMBER</span><span class="k">}</span>
+<span class="nv">BASE_URL</span><span class="o">=</span>https://dist.apache.org/repos/dist/dev/incubator/brooklyn/<span class="k">${</span><span class="nv">BASE_NAME</span><span class="k">}</span>
+
+mkdir -p <span class="k">${</span><span class="nv">TEMP_DIR</span><span class="k">}</span>
+<span class="nb">cd</span> <span class="k">${</span><span class="nv">TEMP_DIR</span><span class="k">}</span>
+<span class="k">for</span> ext in -src.tar.gz -src.zip -bin.tar.gz -bin.zip<span class="p">;</span> <span class="k">do</span>
+ <span class="nv">artifact</span><span class="o">=</span><span class="k">${</span><span class="nv">BASE_NAME</span><span class="k">}${</span><span class="nv">ext</span><span class="k">}</span>
+ <span class="k">for</span> i in <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span> <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.asc <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.md5 <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.sha1 <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.sha256<span class="p">;</span> <span class="k">do</span>
+ curl <span class="k">${</span><span class="nv">BASE_URL</span><span class="k">}</span>/<span class="nv">$i</span> -O
+ <span class="k">done</span>
+<span class="k">done</span></code></pre></div>
+
+<p>Then verify the hashes, and ensure you get a positive message from each one:</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="k">for</span> ext in -src.tar.gz -src.zip -bin.tar.gz -bin.zip<span class="p">;</span> <span class="k">do</span>
+ <span class="nv">artifact</span><span class="o">=</span>apache-brooklyn-<span class="k">${</span><span class="nv">VERSION_NAME</span><span class="k">}</span>-rc<span class="k">${</span><span class="nv">RC_NUMBER</span><span class="k">}${</span><span class="nv">ext</span><span class="k">}</span>
+ md5sum -c <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.md5
+ shasum -a1 -c <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.sha1
+ shasum -a256 -c <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.sha256
+ gpg2 --verify <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>.asc <span class="k">${</span><span class="nv">artifact</span><span class="k">}</span>
+<span class="k">done</span></code></pre></div>
+
+<h2 id="verify-expanded-source-archive-matches-contents-of-rc-tag">Verify expanded source archive matches contents of RC tag</h2>
+
+<p>These commands will compare the contents of the source release to the contents of the equivalent Git commit. Note that
+there will be some differences: we cannot release binary files in the source release, so some test artifacts will
+appear to be missing from the source release, and the source release excludes the documentation, website and release
+scripts.</p>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nb">cd</span> <span class="nv">$BASE_REPO</span>
+git checkout <span class="nv">$GIT_COMMIT</span>
+git clean -d -f -x <span class="c"># WARNING: this will forcibly clean your workspace!</span>
+
+<span class="nb">cd</span> <span class="nv">$TEMP_DIR</span>
+mkdir unpacked-src
+<span class="c"># Either:</span>
+tar xzf <span class="k">${</span><span class="nv">BASE_NAME</span><span class="k">}</span>-src.tar.gz -C unpacked-src/
+<span class="c"># or:</span>
+unzip <span class="k">${</span><span class="nv">BASE_NAME</span><span class="k">}</span>-src.zip -d unpacked-src/
+<span class="c"># (or preferably both!)</span>
+diff -qr unpacked-src/<span class="nv">$BASE_NAME</span> <span class="nv">$BASE_REPO</span></code></pre></div>
+
+<h2 id="verify-the-operation-of-the-binary-distribution">Verify the operation of the binary distribution</h2>
+
+<div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nb">cd</span> <span class="nv">$TEMP_DIR</span>
+mkdir unpacked-bin
+<span class="c"># Either:</span>
+tar xzf <span class="k">${</span><span class="nv">BASE_NAME</span><span class="k">}</span>-bin.tar.gz -C unpacked-bin/
+<span class="c"># or:</span>
+unzip <span class="k">${</span><span class="nv">BASE_NAME</span><span class="k">}</span>-bin.tar.gz -d unpacked-bin/
+<span class="c"># (or preferably both!)</span>
+<span class="nb">cd </span>unpacked-bin
+./bin/brooklyn launch</code></pre></div>
+
+<p>Try deploying a simple app, such as the YAML:</p>
+
+<div class="highlight"><pre><code class="language-yaml" data-lang="yaml"><span class="l-Scalar-Plain">location</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">localhost</span>
+<span class="l-Scalar-Plain">services</span><span class="p-Indicator">:</span>
+<span class="p-Indicator">-</span> <span class="l-Scalar-Plain">type</span><span class="p-Indicator">:</span> <span class="l-Scalar-Plain">brooklyn.entity.webapp.jboss.JBoss7Server</span></code></pre></div>
+
+<h2 id="inspect-the-maven-staging-repository">Inspect the Maven staging repository</h2>
+
+<p>Go to the Apache Nexus server at <a href="https://repository.apache.org/">https://repository.apache.org/</a> and log in using the
+link in the top right (the credentials are the same as your Git and Jenkins credentials). Go to the âStaging
+Repositoriesâ page, and click the repository with the name starting <code>orgapachebrooklyn</code>.</p>
+
+<p>Give this a brief inspection to ensure that it looks reasonable. In particular:</p>
+
+<ul>
+ <li>The expected projects are there. (There is no need to do an exhaustive check - but if there is only a couple of
+projects there, then something has clearly gone wrong!)</li>
+ <li>The projects contain artifacts with the expected version number.</li>
+ <li>The artifacts for a project look reasonable - and there is a <code>.asc</code> file (detached PGP cleartext signature) for each
+artifact.</li>
+</ul>
+
+<h2 id="about-the-sanity-check">About the sanity check</h2>
+
+<p>This is the most basic sanity check. This is now suitable to be uploaded to the pre-release area and an announcement
+made with voting open. This is then the point for the RM and the community to perform more detailed testing on the RC
+artifacts and submit bug reports and votes.</p>
+
+<h2 id="if-the-sanity-check-fails">If the sanity check fails</h2>
+
+<p>Note the problems causing the failure, and file bug reports, start mailing list discussions etc., as appropriate.</p>
+
+<h4 id="for-the-release-manager-who-was-preparing-an-rc-for-upload">For the release manager who was preparing an RC for upload</h4>
+
+<p>You should completely discard the defective artifacts.</p>
+
+<p>You will also need to drop the Maven staging repository on Apacheâs Nexus server: go to the Apache Nexus server at
+<a href="https://repository.apache.org/">https://repository.apache.org/</a> and log in using the link in the top right (the
+credentials are the same as your Git and Jenkins credentials). Go to the âStaging Repositoriesâ page, and tick the
+repository with the name starting <code>orgapachebrooklyn</code>. Click the <strong>Drop</strong> button.</p>
+
+ </div>
+
+ <div class="col-md-3">
+ <div class="list-group side-menu" id="side-menu">
+
+
+
+
+
+
+ <h4 class=" with_following">
+ <a href="/developers/index.html" class="list-group-item breadcrumb breadcrumb0">
+ Developers
+ </a></h4>
+
+ <h4 class=" with_preceding with_following">
+ <a href="/developers/committers/index.html" class="list-group-item breadcrumb breadcrumb1">
+ Committer Guide
+ </a></h4>
+
+ <h4 class=" with_preceding">
+ <a href="/developers/committers/release-process/index.html" class="list-group-item breadcrumb breadcrumb2">
+ Release Process
+ </a></h4>
+
+
+
+
+
+ <a href="/developers/committers/release-process/prerequisites.html" class="list-group-item">Release Prerequisites
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/environment-variables.html" class="list-group-item">Environment variables for the release
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/release-version.html" class="list-group-item">Release branch and set version
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/make-release-artifacts.html" class="list-group-item">Make the release artifacts
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/verify-release-artifacts.html" class="list-group-item active">Verify the release artifacts
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/publish-temp.html" class="list-group-item">Publish to the staging area
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/vote.html" class="list-group-item">Vote on dev@brooklyn
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/fix-release.html" class="list-group-item">Fix on the release branch
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/vote-ipmc.html" class="list-group-item">Vote on general@incubator
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/publish.html" class="list-group-item">Publish to the public
+ </a>
+
+
+
+
+
+ <a href="/developers/committers/release-process/announce.html" class="list-group-item">Announce the release
+ </a>
+
+
+
+
+
+
+
+</div>
+<div id="width_reference"></div>
+
+
+<script language="JavaScript" type="application/javascript">
+
+
+sidemenu_x_sizer=function(){ $('#side-menu').width($('#side-menu').parent().find('#width_reference').outerWidth()); };
+$(sidemenu_x_sizer);
+$(window).resize(sidemenu_x_sizer);
+
+
+sidemenu_y_nonfloater=function(){
+ if ($('#side-menu').outerHeight(true) + $('#header').outerHeight(true) + $('#footer').outerHeight(true) > window.innerHeight ||
+ $('#side-menu').width() >= $('#content_container').width()/2) {
+ $('#side-menu').css('position', 'inherit');
+ } else {
+ // restore if screen has grown
+ $('#side-menu').css('position', 'fixed');
+ }
+};
+$(sidemenu_y_nonfloater);
+$(window).resize(sidemenu_y_nonfloater);
+
+
+
+var sideMenu = $("#side-menu"),
+ sideItems = sideMenu.find("a"),
+ // Anchors corresponding to menu items
+ scrollItems = sideItems.map(function(){
+ var item = $(this).attr("section-target");
+ if (item && item.length) { return item; }
+ });
+
+var highlight_section_last_top = -1;
+var highlight_section_completed = false;
+
+var highlight_section = function() {
+ // Get container scroll position
+ var highlight_section_new_top = $(this).scrollTop();
+ if (highlight_section_new_top == highlight_section_last_top) return;
+ var highlight_section_new_bottom = highlight_section_new_top + $(window).height();
+ var scroll_advancing = (highlight_section_new_top > highlight_section_last_top);
+
+ var last_item = null, active_item = $("#side-menu a.section#active");
+
+ var found_top = false;
+ var displayable_items = scrollItems.map(function(itemI){
+ item = $(scrollItems[itemI]);
+ if (item && item.length) {
+ if (highlight_section_last_top == -1 || !highlight_section_completed) {
+ // just opening page - take item matching hash, or otherwise the first item visible
+ if (item.selector === window.location.hash || (item.offset().top > highlight_section_new_top - 20 && !found_top)) {
+ found_top = true;
+ if (item.selector === window.location.hash && item.offset().top < highlight_section_new_top + 60) {
+ // because of our top header, we need to scroll 64px down from any link
+ $('html, body').animate({scrollTop: item.offset().top - 64}, 0);
+ }
+ return item;
+ }
+ } else if (scroll_advancing) {
+ // if scrolling advance, pick up a section when title starts before 1/3 height
+ if (item.offset().top < highlight_section_new_top + $(window).height()/3)
+ return item;
+
+ // or if containing div is finished (usu the whole main content)
+ div_containing_item = item.closest("div");
+ if (div_containing_item.offset().top + div_containing_item.height() < highlight_section_new_bottom + 15)
+ return item;
+ // or when next title is visible
+ if (last_item && item.offset().top < highlight_section_new_bottom + 15)
+ return last_item;
+ } else {
+ // if scrolling back, pick up a section as soon as the title is visible,
+ if (item.offset().top < highlight_section_new_top)
+ return item;
+ // or if title is before the 2/3 point
+ // (not sure about this, probably want also to have
+ // "AND the id.top is <= displayable_itemsrent_active_it.top" so we don't jump FORWARD a section
+ // when scrolling BACK, with lots of tiny sections)
+ if ((item.offset().top < highlight_section_new_top + 2*$(window).height()/3)
+ && (!active_item || !active_item.offset() || active_item.offset().top >= item.offset().top))
+ return item;
+
+ }
+ last_item = item;
+ }
+ });
+ if (!highlight_section_completed && document.readyState === "complete") {
+ highlight_section_completed = true;
+ }
+ if (!displayable_items.length) {
+ $("#side-menu a.section").removeClass("active");
+ } else {
+ displayable_items = displayable_items[displayable_items.length-1];
+ var id = displayable_items && displayable_items.length ? displayable_items[0].id : "";
+ // Set/remove active class
+ new_active = $("#side-menu a.section").filter("[section-target='#"+id+"']");
+ if (new_active.hasClass("active")) {
+ // nothing needed
+ } else {
+ $("#side-menu a.section").removeClass("active");
+ $("#side-menu a.section").filter("[section-target='#"+id+"']").addClass("active");
+ }
+ }
+
+ highlight_section_last_top = highlight_section_new_top;
+};
+var highlight_new_section = function() {
+ highlight_section_completed = false;
+ highlight_section_last_top = -1;
+ highlight_section();
+}
+
+$(window).scroll(highlight_section);
+$(highlight_new_section);
+
+// detect link change - courtesy http://www.bennadel.com/blog/1520-binding-events-to-non-dom-objects-with-jquery.htm
+ (
+ function( $ ){
+ // Default to the current location.
+ var strLocation = window.location.href;
+ var strHash = window.location.hash;
+ var strPrevLocation = "";
+ var strPrevHash = "";
+
+ // This is how often we will be checkint for
+ // changes on the location.
+ var intIntervalTime = 100;
+
+ // This method removes the pound from the hash.
+ var fnCleanHash = function( strHash ){
+ return(
+ strHash.substring( 1, strHash.length )
+ );
+ }
+
+ // This will be the method that we use to check
+ // changes in the window location.
+ var fnCheckLocation = function(){
+ // Check to see if the location has changed.
+ if (strLocation != window.location.href){
+
+ // Store the new and previous locations.
+ strPrevLocation = strLocation;
+ strPrevHash = strHash;
+ strLocation = window.location.href;
+ strHash = window.location.hash;
+
+ // The location has changed. Trigger a
+ // change event on the location object,
+ // passing in the current and previous
+ // location values.
+ $( window.location ).trigger(
+ "change",
+ {
+ currentHref: strLocation,
+ currentHash: fnCleanHash( strHash ),
+ previousHref: strPrevLocation,
+ previousHash: fnCleanHash( strPrevHash )
+ }
+ );
+
+ }
+ }
+
+ // Set an interval to check the location changes.
+ setInterval( fnCheckLocation, intIntervalTime );
+ }
+ )( jQuery );
+// and trigger highlight section on link change
+$(window.location).bind("change", highlight_new_section);
+
+</script>
+
+ </div>
+ </div>
+</div>
+
+<div id="footer">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-10 text-muted">
+ Apache Brooklyn is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
+ License v2.0</a>.
+ <br />
+ Apache Brooklyn is currently undergoing Incubation at The Apache Software
+ Foundation.
+ </div>
+ <div class="col-md-2">
+ <a class="btn btn-sm btn-default" href="https://github.com/apache/incubator-brooklyn/edit/master/docs/website/developers/committers/release-process/verify-release-artifacts.md">Edit This Page</a>
+ <a href="https://brooklyn.incubator.apache.org/community/how-to-contribute-docs.html"
+ data-toggle="tooltip" data-placement="top" title="How to Edit Documentation" data-delay="400"/>
+ <span class="octicon octicon-question octicon-footer"></span>
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+<script src="//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.min.js"></script>
+
+<script language="JavaScript" type="application/javascript">
+ fix_padding_function = function () {
+ $('body').css('padding-top', parseInt($('#header').css("height"))+10);
+ $('body').css('padding-bottom', parseInt($('#footer').css("height"))+10);
+ };
+ $(window).resize(fix_padding_function);
+ $(window).load(fix_padding_function);
+
+ $(function () {
+ $('[data-toggle="tooltip"]').tooltip({ delay: { show: 600, hide: 100 }})
+ });
+
+/* generate anchors for headers, a la github and http://blog.parkermoore.de/2014/08/01/header-anchor-links-in-vanilla-javascript-for-github-pages-and-jekyll/ */
+var anchorForId = function (id, text) {
+ var anchor = document.createElement("a");
+ anchor.className = "header-link";
+ anchor.href = "#" + id;
+ anchor.innerHTML = "<i class=\"fa fa-link\"></i>";
+ return anchor;
+};
+
+var linkifyAnchors = function (level, containingElement) {
+ var headers = contentBlock.find("h" + level);
+ for (var h = 0; h < headers.length; h++) {
+ var header = headers[h];
+ if (typeof header.id !== "undefined" && header.id !== "") {
+ header.appendChild(anchorForId(header.id, $(header).text()));
+ }
+ }
+};
+
+$(function () {
+ contentBlock = $("#content_container");
+ if (!contentBlock) return;
+ for (var level = 1; level <= 6; level++) {
+ linkifyAnchors(level, contentBlock);
+ }
+});
+
+<!-- Clipboard support -->
+ ZeroClipboard.config({ moviePath: '//cdnjs.cloudflare.com/ajax/libs/zeroclipboard/1.3.1/ZeroClipboard.swf' });
+
+$(function() {
+ $('div.highlight').prepend(
+ $('<div class="clipboard_container" title="Copy to Clipboard">'+
+ '<div class="fa clipboard_button">'+
+ '<div class="on-active"><div>Copied to Clipboard</div></div>'+
+ '</div></div>'));
+ $('div.clipboard_container').each(function(index) {
+ var clipboard = new ZeroClipboard();
+ clipboard.clip( $(this).find(":first")[0], $(this)[0] );
+ var target = $(this).next();
+ var txt = target.text().trim();
+ if (target.find('code.bash')) {
+ // Strip out bash prompts from the start of each line (i.e. '$' or '%' characters
+ // at the very start, or immediately following any newline). Correctly handles continuation
+ // lines, where a leading '$' or '%' is *not* a prompt character.
+ txt = txt.replace(/(^|[^\\]\n)[$%] /g, "$1");
+ }
+ clipboard.on( 'dataRequested', function (client, args) {
+ client.setText( txt );
+ });
+ });
+});
+
+<!-- search -->
+ $(function() {
+ $('#simple_google')
+ .submit(function() {
+ $('input[name="q"]').val("site:" + document.location.hostname + " " + $('input[name="brooklyn-search"]').val());
+ return true;
+ });
+ $('input[name="brooklyn-search"]').focus(function() {
+ if ($(this).val() === $(this).attr('placeholder')) {
+ $(this).val('');
+ }
+ })
+ .blur(function() {
+ if ($(this).val() === '') {
+ $(this).val($(this).attr('placeholder'));
+ }
+ })
+ .blur();
+ });
+
+
+ <!-- analytics -->
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-30530918-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+
+<!-- page warning (for archive pages) -->
+
+
+ function get_user_versions() {
+ return $.cookie("brooklyn_versions") ? $.cookie("brooklyn_versions").split(",") : [];
+ };
+ function set_user_version(version) {
+ var version_cookie = get_user_versions();
+ version_cookie.push(version);
+ $.cookie('brooklyn_versions', version_cookie, { expires: 365, path: '/' });
+ $('#page_notes').fadeOut();
+ event.preventDefault ? event.preventDefault() : event.returnValue = false;
+ };
+ function set_user_versions_all() {
+ var version_cookie = get_user_versions();
+ version_cookie.push("ALL");
+ $.cookie('brooklyn_versions', version_cookie, { expires: 365, path: '/' });
+ $('#page_notes').fadeOut();
+ event.preventDefault ? event.preventDefault() : event.returnValue = false;
+ };
+ function clear_user_versions() {
+ $.removeCookie('brooklyn_versions', { path: '/' });
+ $('#page_notes').fadeIn('slow');
+ event.preventDefault ? event.preventDefault() : event.returnValue = false;
+ };
+
+</script>
+
+</body>
+
+</html>