[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[
https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15930800#comment-15930800
]
Munagala V. Ramanath commented on APEXCORE-526:
---
We now have two functions: `add_apex_malhar_builders()` and
`add_apex_core_builders()`
There is a list in each function named _branches_; for *Malhar* it has:
{code}
branches = ['release-3.5', 'release-3.6']
{code}
for *Core* it has:
{code}
branches = ['release-3.4', 'release-3.5']
{code}
Adding a new release for either branch is now simply a matter of adding the
appropriate branch name to one of
the above lists.
> Publish javadoc for releases on ASF infrastructure
> ---
>
> Key: APEXCORE-526
> URL: https://issues.apache.org/jira/browse/APEXCORE-526
> Project: Apache Apex Core
> Issue Type: Documentation
>Reporter: Thomas Weise
>Assignee: Munagala V. Ramanath
>
> Every release should have the javadocs published and we should have it linked
> from the download page, as is the case with user docs.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15930353#comment-15930353 ] Munagala V. Ramanath commented on APEXCORE-526: --- https://ci.apache.org/projects/apex-core/apex-core-javadoc-release-3.4/index.html https://ci.apache.org/projects/apex-core/apex-core-javadoc-release-3.5/index.html Javadocs for Apex Core releases 3.4 and 4.5 are now available at the above links. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.15#6346)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15895847#comment-15895847 ] Munagala V. Ramanath commented on APEXCORE-526: --- Hoping to have this done this month -- sooner rather than later. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.15#6346)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15895829#comment-15895829 ] Thomas Weise commented on APEXCORE-526: --- [~dtram] any update on getting this setup for apex-core and the master branches? We also need to update http://apex.apache.org/release.html so the release manager can make sure the docs are available before finalizing the release. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.15#6346)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15732733#comment-15732733 ] Thomas Weise commented on APEXCORE-526: --- I updated the download page to include the javadoc links: http://apex.apache.org/downloads.html Would be good to have the same for apex-core. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15718563#comment-15718563 ] Munagala V. Ramanath commented on APEXCORE-526: --- The infrastructure folks have added additional memory and disk and the build has now successfully completed. Both the org.apache.apex.malhar.kafka and the org.apache.apex.malhar.sql packages are now present. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15717143#comment-15717143 ] Munagala V. Ramanath commented on APEXCORE-526: --- I fixed it but the build is now failing due to space issues on the build master -- waiting for infra folks to address this. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716805#comment-15716805 ] Thomas Weise commented on APEXCORE-526: --- Look for the Kafka 0.9 and SQL packages. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716775#comment-15716775 ] Munagala V. Ramanath commented on APEXCORE-526: --- What's missing ? After adding that option what should I look for ? > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise >Assignee: Munagala V. Ramanath > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716260#comment-15716260 ] Thomas Weise commented on APEXCORE-526: --- There seems to be part of the documentation missing. Are you building it with -Pall-modules ? > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716179#comment-15716179 ] Munagala V. Ramanath commented on APEXCORE-526: --- Yes, it can would take a bit more work. The 3.6 docs are now available. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716174#comment-15716174 ] Munagala V. Ramanath commented on APEXCORE-526: --- Looks like the build was successful: https://ci.apache.org/projects/apex-malhar/apex-malhar-javadoc-release-3.6/index.html > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716106#comment-15716106 ] Thomas Weise commented on APEXCORE-526: --- Can it be setup to build whenever there are commits pushed to branches? That would be better than scheduling. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15716088#comment-15716088 ] Munagala V. Ramanath commented on APEXCORE-526: --- Pushed changes to build a list of branches; also changed the slaves on which the build is supposed to run to avoid earlier failures. Tried to force a build from irc but it is not working for some reason -- trying to figure it out. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15712857#comment-15712857 ] Munagala V. Ramanath commented on APEXCORE-526: --- Working on it now actually -- a bit more than that -- need to create an array of branch names and iterate over it. Shouldn't be too long though. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15712833#comment-15712833 ] Thomas Weise commented on APEXCORE-526: --- Ram, I assume it is just a one liner to add the Malhar release-3.6 branch? > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[
https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15690911#comment-15690911
]
Munagala V. Ramanath commented on APEXCORE-526:
---
Anything that can be generated with a sequence of shell command can be added.
The Python code and hence the documentation for it can change as we add more
branches and features but here is a quick summary of the current state:
*Buildbot* is a Python-based tool CI tool. Build services using buildbot are
available
on Apache infrastructure with some very basic documentation at
[https://ci.apache.org/buildbot.html]
Included on that page are various links to view the status of recent builds.
Buildbot is configured via configuration files with the *{{.conf}}* extension;
these files
are not just key-value pairs but rather full Python scripts.
The configuration file for Apache projects are in an SVN repo at:
[https://svn.apache.org/repos/infra/infrastructure/buildbot/aegis/buildmaster/master1/projects]
There are files for around 70 projects and looking at those files is a good way
to figure out how to setup a build.
The Apex build is in *{{apex.conf}}*. All configuration files are catenated
together before
execution, so we need to be mindful of potential name clashes. The result of
running the
configuration file should be to append suitable objects to the global map named
simply *{{c}}*.
Commonly, we create and append a builder object to *{{c['builders']}}* and a
scheduler object to
*{{c['schedulers']}}*.
A builder is just a key-value map containing things like the builder name, list
of slaves
to run the build on, environment variable settings and, most importantly, a
*BuildFactory*
which holds the various steps of the build.
In the Apex case, we define a function named *{{add_apex_malhar_builders()}}*
and invoke it;
this minimizes the likelihood of global name clashes. We create a build factory
containing
these steps:
{quote}
(a) Run git to checkout desired branch.
(b) Run mvn to generate the javadocs.
(c) Cleanup tmp directory.
(d) Upload files to master.
(e) Publish files to appropriate directory on master.
(f) Cleanup tmp directory again.
We explicitly set *JAVA_HOME* to point to 1.8 to avoid some build problems.
This path
is not uniform on all the slaves and causes the build to fail sometimes
depending
on which slave it runs on; a fix is pending.
We add a single scheduler which schedules a build every 24hrs.
Once the *{{apex.conf}}* file is checked back in to the SVN repository after
making changes
it should take effect a few minutes later.
> Publish javadoc for releases on ASF infrastructure
> ---
>
> Key: APEXCORE-526
> URL: https://issues.apache.org/jira/browse/APEXCORE-526
> Project: Apache Apex Core
> Issue Type: Documentation
>Reporter: Thomas Weise
>
> Every release should have the javadocs published and we should have it linked
> from the download page, as is the case with user docs.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15688112#comment-15688112 ] Thomas Weise commented on APEXCORE-526: --- It would be good to document what we have for Malhar so that others can add the branches when needed. I would like to make this part of the upcoming 3.6 release. Would it be (later) possible to generate the user docs with this process also? > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15660889#comment-15660889 ] Hitesh Shah commented on APEXCORE-526: -- A different option would be to change the release process where in the javadocs are generated manually and copied over the apex-site repo that serves the content of the apex.apache.org website. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15659494#comment-15659494 ] Thomas Weise commented on APEXCORE-526: --- Can you please provide information on how to maintain this. Where is the configuration, how do we add new branches as part of the release process (may need to add relevant info to http://apex.apache.org/release.html)? Also, will commits to respective branches trigger the build? > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15631520#comment-15631520 ] Munagala V. Ramanath commented on APEXCORE-526: --- https://ci.apache.org/projects/apex-malhar/apex-malhar-javadoc-release-3.5/ The Malhar javadocs are now available there. > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15503804#comment-15503804 ] Thomas Weise commented on APEXCORE-526: --- We can setup the project on buildbot to build javadoc:aggregate and then move it to public-html space. https://svn.apache.org/repos/infra/infrastructure/buildbot/aegis/buildmaster/master1/projects/template.conf > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (APEXCORE-526) Publish javadoc for releases on ASF infrastructure
[ https://issues.apache.org/jira/browse/APEXCORE-526?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15485165#comment-15485165 ] Thomas Weise commented on APEXCORE-526: --- Some projects use the CI to generate and host the javadoc, this may be a good option. https://ci.apache.org/projects/ > Publish javadoc for releases on ASF infrastructure > --- > > Key: APEXCORE-526 > URL: https://issues.apache.org/jira/browse/APEXCORE-526 > Project: Apache Apex Core > Issue Type: Documentation >Reporter: Thomas Weise > Labels: newbie > > Every release should have the javadocs published and we should have it linked > from the download page, as is the case with user docs. -- This message was sent by Atlassian JIRA (v6.3.4#6332)
