yetus-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bus...@apache.org
Subject yetus git commit: YETUS-163 parameterize docs/downloads per release.
Date Thu, 19 Nov 2015 06:51:16 GMT
Repository: yetus
Updated Branches:
  refs/heads/master 0e3d5ef40 -> 6e95a5631


YETUS-163 parameterize docs/downloads per release.


Project: http://git-wip-us.apache.org/repos/asf/yetus/repo
Commit: http://git-wip-us.apache.org/repos/asf/yetus/commit/6e95a563
Tree: http://git-wip-us.apache.org/repos/asf/yetus/tree/6e95a563
Diff: http://git-wip-us.apache.org/repos/asf/yetus/diff/6e95a563

Branch: refs/heads/master
Commit: 6e95a563162e1020d93bedda76ac593f395f13b6
Parents: 0e3d5ef
Author: Sean Busbey <busbey@apache.org>
Authored: Sun Nov 1 10:34:48 2015 -0600
Committer: Sean Busbey <busbey@apache.org>
Committed: Thu Nov 19 00:39:17 2015 -0600

----------------------------------------------------------------------
 asf-site-src/config.rb                    | 19 +++++++++++
 asf-site-src/data/versions.yml            | 17 ++++++++++
 asf-site-src/source/_header.md.erb        | 12 ++++++-
 asf-site-src/source/downloads.html.md     | 24 --------------
 asf-site-src/source/downloads.html.md.erb | 45 ++++++++++++++++++++++++++
 5 files changed, 92 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/yetus/blob/6e95a563/asf-site-src/config.rb
----------------------------------------------------------------------
diff --git a/asf-site-src/config.rb b/asf-site-src/config.rb
index e0ff36e..1c372e7 100644
--- a/asf-site-src/config.rb
+++ b/asf-site-src/config.rb
@@ -86,6 +86,20 @@ def shelldocs(output, docs=[])
   end
 end
 
+RELEASEDOCMAKER = File.absolute_path('../release-doc-maker/releasedocmaker.py')
+
+def releasenotes(output, version)
+  # TODO: check jira for last update to the version and compare to source
+  #       file timestamp
+  `(cd #{output} && #{RELEASEDOCMAKER} --project=YETUS --version=#{version} \
+                                       --projecttitle="Apache Yetus" \
+                                       --usetoday --license --lint)`
+  FileUtils.mv("#{output}/#{version}/RELEASENOTES.#{version}.md",
+               "#{output}/#{version}/RELEASENOTES.md")
+  FileUtils.mv("#{output}/#{version}/CHANGES.#{version}.md",
+               "#{output}/#{version}/CHANGES.md")
+end
+
 # Add in apidocs rendered by other parts of the repo
 after_configuration do
   # For Audiene Annotations we just rely on having made javadocs with Maven
@@ -100,4 +114,9 @@ after_configuration do
   shelldocs('source/documentation/in-progress/precommit-apidocs/test-patch.md', ['../precommit/test-patch.sh'])
   # plugins API
   shelldocs('source/documentation/in-progress/precommit-apidocs/plugins.md', Dir.glob('../precommit/test-patch.d/*.sh'))
+  unless data.versions.releases.nil?
+    data.versions.releases.each do |release|
+      releasenotes('source/documentation', release)
+    end
+  end
 end

http://git-wip-us.apache.org/repos/asf/yetus/blob/6e95a563/asf-site-src/data/versions.yml
----------------------------------------------------------------------
diff --git a/asf-site-src/data/versions.yml b/asf-site-src/data/versions.yml
new file mode 100644
index 0000000..30e78e8
--- /dev/null
+++ b/asf-site-src/data/versions.yml
@@ -0,0 +1,17 @@
+# 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.
+releases:

http://git-wip-us.apache.org/repos/asf/yetus/blob/6e95a563/asf-site-src/source/_header.md.erb
----------------------------------------------------------------------
diff --git a/asf-site-src/source/_header.md.erb b/asf-site-src/source/_header.md.erb
index 8b1b13c..a9609ed 100644
--- a/asf-site-src/source/_header.md.erb
+++ b/asf-site-src/source/_header.md.erb
@@ -33,7 +33,17 @@
         <div class="navbar-collapse collapse">
             <ul class="nav navbar-nav">
                 <li><a href="/downloads/">Downloads</a>
-                <li><a href="/documentation/in-progress/">Documentation</a>
+                <li class="dropdown">
+                    <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation
<span class="caret"></span></a>
+                    <ul class="dropdown-menu" role="menu">
+<% unless data.versions.releases.nil?
+     data.versions.releases.each do |release| %>
+                      <li><a href="/documentation/<%= release %>/">Docs
for v<%= release %></a></li>
+<%   end
+   end %>
+                      <li><a href="/documentation/in-progress/">In Progress Docs
for Contributors</a>
+                      </li>
+                    </ul>
                 </li>
                 <li class="dropdown">
                     <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get
Involved <span class="caret"></span></a>

http://git-wip-us.apache.org/repos/asf/yetus/blob/6e95a563/asf-site-src/source/downloads.html.md
----------------------------------------------------------------------
diff --git a/asf-site-src/source/downloads.html.md b/asf-site-src/source/downloads.html.md
deleted file mode 100644
index b15f729..0000000
--- a/asf-site-src/source/downloads.html.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!---
-  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.
--->
-
-Coming soon!
-
-As a new top-level project split from another top level Apache project, we 
-are currently establishing an independent build and release process.  If you would
-like to help out, check out the Getting Involved link above!

http://git-wip-us.apache.org/repos/asf/yetus/blob/6e95a563/asf-site-src/source/downloads.html.md.erb
----------------------------------------------------------------------
diff --git a/asf-site-src/source/downloads.html.md.erb b/asf-site-src/source/downloads.html.md.erb
new file mode 100644
index 0000000..466dd29
--- /dev/null
+++ b/asf-site-src/source/downloads.html.md.erb
@@ -0,0 +1,45 @@
+<!---
+  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.
+-->
+<% if data.versions.releases.nil? %>
+Coming soon!
+
+As a new top-level project split from another top level Apache project, we
+are currently establishing an independent build and release process.  If you would
+like to help out, check out the Getting Involved link above!
+<% else %>
+# Apache Yetus Downloads
+
+The Apache Yetus project publishes a single source artifact per release for all of
+our components as well as a convenience artifact of binaries and documentation for immediate
use. You
+should verify the integrity of these artifacts via [the ASF procedure](https://www.apache.org/info/verification.html)
+using the [KEYS file for our project](https://dist.apache.org/repos/dist/release/yetus/KEYS).
+
+In addition to the artifacts below, we publish convenience artifacts in some
+third-party repositories (e.g. Maven Central).
+
+## Releases
+
+<%   data.versions.releases.each do | release | %>
+  * <%= release %>
+    * [Release Notes](/documentation/<%= release %>/RELEASENOTES)
+    * [CHANGES](/documentation/<%= release %>/CHANGES)
+    * Source : [yetus-<%= release %>-source.zip](https://www.apache.org/dyn/closer.lua?path=/yetus/<%=
release %>/yetus-<%= release %>-source.zip) ([signature](https://www.apache.org/dist/yetus/<%=
release %>/yetus-<%= release %>-source.zip.asc), [hashes](https://www.apache.org/dist/yetus/<%=
release %>/yetus-<%= release %>-source.zip.mds))
+    * Binaries : [yetus-<%= release %>-bin.zip](https://www.apache.org/dyn/closer.lua?path=/yetus/<%=
release %>/yetus-<%= release %>-bin.zip) ([signature](https://www.apache.org/dist/yetus/<%=
release %>/yetus-<%= release %>-bin.zip.asc), [hashes](https://www.apache.org/dist/yetus/<%=
release %>/yetus-<%= release %>-bin.zip.mds))
+<%   end
+   end %>


Mime
View raw message