You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apex.apache.org by sa...@apache.org on 2016/01/05 03:16:18 UTC

incubator-apex-site git commit: APEXCORE-292 Adding JIRAs search link for Core, Malhar; Adding documentation about fetch-roadmap task, which produces roadmap.json

Repository: incubator-apex-site
Updated Branches:
  refs/heads/master 42521a268 -> 52e5917a5


APEXCORE-292 Adding JIRAs search link for Core, Malhar; Adding documentation about fetch-roadmap task, which produces roadmap.json


Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/commit/52e5917a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/tree/52e5917a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-site/diff/52e5917a

Branch: refs/heads/master
Commit: 52e5917a5988d1d6592a72f12a49fec3724158fa
Parents: 42521a2
Author: sashadt <sa...@datatorrent.com>
Authored: Mon Jan 4 18:16:12 2016 -0800
Committer: sashadt <sa...@datatorrent.com>
Committed: Mon Jan 4 18:16:12 2016 -0800

----------------------------------------------------------------------
 README.md              | 16 +++++++++
 gulpfile.js            | 17 +++++-----
 roadmap.json           | 82 +++++++++++++++++++++++++++++++++++++++++++--
 src/pages/roadmap.html | 12 ++++---
 4 files changed, 111 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/52e5917a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 43621fd..14487df 100644
--- a/README.md
+++ b/README.md
@@ -123,3 +123,19 @@ This will do the following things:
 
 
 Once you have committed the changes to `releases.json`, follow the steps to contributing steps to publish the site to go live.
+
+
+
+Updating Roadmap Page
+---------------------
+
+The roadmap page uses [roadmap.json](roadmap.json) to populate the Core and Malhar roadmap JIRA list.  The `roadmap.json` can be automatically generated via JIRA API calls by running:
+
+```bash
+gulp fetch-roadmap
+git add roadmap.json
+git commit -m 'Updating roadmap'
+```
+
+Once changes have been committed, follow the regular site publishing steps to update and publish `roadmap.html`.
+

http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/52e5917a/gulpfile.js
----------------------------------------------------------------------
diff --git a/gulpfile.js b/gulpfile.js
index 79aea35..db0d709 100644
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -117,14 +117,14 @@ gulp.task('default', ['less', 'html', 'copy:js', 'copy:images']);
 gulp.task('fetch-roadmap', function(taskCb) {
 
   var projects = [
-    { key: 'core', name: 'APEXCORE', apiUrl: 'https://issues.apache.org/jira/rest/api/2/', browseUrl: 'https://issues.apache.org/jira/browse' },
-    { key: 'malhar', name: 'APEXMALHAR', apiUrl: 'https://issues.apache.org/jira/rest/api/2/', browseUrl: 'https://issues.apache.org/jira/browse' }
+    { key: 'core', name: 'APEXCORE', apiUrl: 'https://issues.apache.org/jira/rest/api/2/', url: 'https://issues.apache.org/jira/' },
+    { key: 'malhar', name: 'APEXMALHAR', apiUrl: 'https://issues.apache.org/jira/rest/api/2/', url: 'https://issues.apache.org/jira/' }
   ];  
 
   // JQL terms are separated with AND/OR and parameters outside JQL are separated with &
   // 
-  // Query to look up all APEXCORE issues with label of roadmap
-  //    https://issues.apache.org/jira/rest/api/2/search?jql=project=APEXCORE+AND+labels+in+(roadmap)&startAt=0&maxResults=100
+  // Query to look up all APEXCORE and APEXMALHAR issues with label of roadmap
+  //    https://issues.apache.org/jira/rest/api/2/search?jql=project+in+(APEXCORE,APEXMALHAR)+AND+labels+in+(roadmap)+and+fixVersion+in+(EMPTY,unreleasedVersions())+ORDER+BY+key
   //
   // Query which returns only specified fields
   //    https://issues.apache.org/jira/rest/api/2/search?jql=project=APEXCORE+AND+labels+in+(roadmap)&startAt=0&maxResults=100&fields=summary,priority,status
@@ -132,11 +132,10 @@ gulp.task('fetch-roadmap', function(taskCb) {
   // Query to get list of all APEXCORE versions
   //    https://issues.apache.org/jira/rest/api/2/project/APEXCORE/versions
   //
-  // Browse a single JIRA issue is browseUrl + issue.key
+  // Browse JIRA, version, roadmap
   //    https://issues.apache.org/jira/browse/APEXCORE-292
-  // 
-  // Browse a version in the roadmap is browseUrl + project + fixforversion + version.id
   //    https://issues.apache.org/jira/browse/APEXCORE/fixforversion/12333948
+  //    https://issues.apache.org/jira/issues/?jql=project+in+(APEXCORE,APEXMALHAR)+AND+labels+in+(roadmap)+and+fixVersion+in+(EMPTY,unreleasedVersions())+ORDER+BY+key
 
 
   // For each project, get the jiras
@@ -167,7 +166,7 @@ gulp.task('fetch-roadmap', function(taskCb) {
         });
 
         var apiRequest = {
-          jql: 'project = ' + project.name + ' AND labels in (roadmap) AND status NOT IN ( Closed, Resolved )',
+          jql: 'project = ' + project.name + ' AND labels in (roadmap) AND fixVersion in (EMPTY, unreleasedVersions())',
           startAt: 0,
           maxResults: 1000,
           fields: ['summary','priority','status','fixVersions','description']
@@ -261,7 +260,7 @@ gulp.task('fetch-roadmap', function(taskCb) {
       _.set(fileContents, project.key, 
         {
           name: project.name,
-          browseUrl: project.browseUrl,
+          url: project.url,
           jiras: project.jiras,
           versions: project.versions
         });

http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/52e5917a/roadmap.json
----------------------------------------------------------------------
diff --git a/roadmap.json b/roadmap.json
index e0a704a..237caab 100644
--- a/roadmap.json
+++ b/roadmap.json
@@ -1,7 +1,7 @@
 {
   "core": {
     "name": "APEXCORE",
-    "browseUrl": "https://issues.apache.org/jira/browse",
+    "url": "https://issues.apache.org/jira/",
     "jiras": [
       {
         "expand": "operations,editmeta,changelog,transitions,renderedFields",
@@ -491,7 +491,7 @@
   },
   "malhar": {
     "name": "APEXMALHAR",
-    "browseUrl": "https://issues.apache.org/jira/browse",
+    "url": "https://issues.apache.org/jira/",
     "jiras": [
       {
         "expand": "operations,editmeta,changelog,transitions,renderedFields",
@@ -557,6 +557,84 @@
       },
       {
         "expand": "operations,editmeta,changelog,transitions,renderedFields",
+        "id": "12926158",
+        "self": "https://issues.apache.org/jira/rest/api/2/issue/12926158",
+        "key": "APEXMALHAR-1812",
+        "fields": {
+          "summary": "Support Anti Join",
+          "description": "Create a new operator to anti-join two datasets. An anti-join is the opposite to the regular join. An anti-join of R with S will output a tuple from R if it doesn't join with any tuple in S. This can also be useful if we support (NOT)EXISTS subqueries later.",
+          "fixVersions": [
+            {
+              "self": "https://issues.apache.org/jira/rest/api/2/version/12334589",
+              "id": "12334589",
+              "name": "3.3.0",
+              "archived": false,
+              "released": false
+            }
+          ],
+          "priority": {
+            "self": "https://issues.apache.org/jira/rest/api/2/priority/3",
+            "iconUrl": "https://issues.apache.org/jira/images/icons/priorities/major.png",
+            "name": "Major",
+            "id": "3"
+          },
+          "status": {
+            "self": "https://issues.apache.org/jira/rest/api/2/status/5",
+            "description": "A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.",
+            "iconUrl": "https://issues.apache.org/jira/images/icons/statuses/resolved.png",
+            "name": "Resolved",
+            "id": "5",
+            "statusCategory": {
+              "self": "https://issues.apache.org/jira/rest/api/2/statuscategory/3",
+              "id": 3,
+              "key": "done",
+              "colorName": "green",
+              "name": "Complete"
+            }
+          }
+        }
+      },
+      {
+        "expand": "operations,editmeta,changelog,transitions,renderedFields",
+        "id": "12926157",
+        "self": "https://issues.apache.org/jira/rest/api/2/issue/12926157",
+        "key": "APEXMALHAR-1813",
+        "fields": {
+          "summary": "Support Semi Join",
+          "description": "Create an new operator to SQL-like semi join two datasets. A semi join of R with S will output a tuple from R if it joins with any tuple in S. This can also be useful if we support IN subqueries later.",
+          "fixVersions": [
+            {
+              "self": "https://issues.apache.org/jira/rest/api/2/version/12334589",
+              "id": "12334589",
+              "name": "3.3.0",
+              "archived": false,
+              "released": false
+            }
+          ],
+          "priority": {
+            "self": "https://issues.apache.org/jira/rest/api/2/priority/3",
+            "iconUrl": "https://issues.apache.org/jira/images/icons/priorities/major.png",
+            "name": "Major",
+            "id": "3"
+          },
+          "status": {
+            "self": "https://issues.apache.org/jira/rest/api/2/status/5",
+            "description": "A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.",
+            "iconUrl": "https://issues.apache.org/jira/images/icons/statuses/resolved.png",
+            "name": "Resolved",
+            "id": "5",
+            "statusCategory": {
+              "self": "https://issues.apache.org/jira/rest/api/2/statuscategory/3",
+              "id": 3,
+              "key": "done",
+              "colorName": "green",
+              "name": "Complete"
+            }
+          }
+        }
+      },
+      {
+        "expand": "operations,editmeta,changelog,transitions,renderedFields",
         "id": "12926152",
         "self": "https://issues.apache.org/jira/rest/api/2/issue/12926152",
         "key": "APEXMALHAR-1818",

http://git-wip-us.apache.org/repos/asf/incubator-apex-site/blob/52e5917a/src/pages/roadmap.html
----------------------------------------------------------------------
diff --git a/src/pages/roadmap.html b/src/pages/roadmap.html
index fe704ee..c56de6d 100644
--- a/src/pages/roadmap.html
+++ b/src/pages/roadmap.html
@@ -3,7 +3,9 @@
 <div class="container">
   
   <h1>Apex Roadmap</h1>
-  
+
+  Summary of key <a target="_blank" href="{{ roadmap.core.url }}issues/?jql=project+in+({{roadmap.core.name}},{{roadmap.malhar.name}})+AND+labels+in+(roadmap)+and+fixVersion+in+(EMPTY,unreleasedVersions())+ORDER+BY+key">JIRAs</a> planned for future releases of Apex Core and Malhar.
+
   <!-- APEX CORE ROADMAP -->
   {{#if roadmap.core.jiras.length}}
   <h2>Core</h2>
@@ -19,7 +21,7 @@
       {{#each roadmap.core.jiras as |jira jIndex|}}
       <tr>
         <td>
-          <a target="_blank" href="{{ ../roadmap.core.browseUrl }}/{{ jira.key }}">{{ jira.key }}</a>
+          <a target="_blank" href="{{ ../roadmap.core.url }}browse/{{ jira.key }}">{{ jira.key }}</a>
         </td>
         <td title="{{ jira.fields.description }}">
           {{jira.fields.summary}}
@@ -28,7 +30,7 @@
     
           {{#each jira.fields.fixVersions as |version vIndex|}}
 
-            <a target="_blank" href="{{ ../../roadmap.core.browseUrl }}/{{ ../../roadmap.core.name }}/fixforversion/{{ version.id }}">{{ version.name }}</a>&nbsp;
+            <a target="_blank" href="{{ ../../roadmap.core.url }}browse/{{ ../../roadmap.core.name }}/fixforversion/{{ version.id }}">{{ version.name }}</a>&nbsp;
 
           {{/each}}
 
@@ -54,7 +56,7 @@
       {{#each roadmap.malhar.jiras as |jira jIndex|}}
       <tr>
         <td>
-          <a target="_blank" href="{{ ../roadmap.malhar.browseUrl }}/{{ jira.key }}">{{ jira.key }}</a>
+          <a target="_blank" href="{{ ../roadmap.malhar.url }}browse/{{ jira.key }}">{{ jira.key }}</a>
         </td>
         <td title="{{ jira.fields.description }}">
           {{jira.fields.summary}}
@@ -63,7 +65,7 @@
     
           {{#each jira.fields.fixVersions as |version vIndex|}}
 
-            <a target="_blank" href="{{ ../../roadmap.malhar.browseUrl }}/{{ ../../roadmap.malhar.name }}/fixforversion/{{ version.id }}">{{ version.name }}</a>&nbsp;
+            <a target="_blank" href="{{ ../../roadmap.malhar.url }}browse/{{ ../../roadmap.malhar.name }}/fixforversion/{{ version.id }}">{{ version.name }}</a>&nbsp;
 
           {{/each}}