Derby
  1. Derby
  2. DERBY-5272

Stop building Eclipse plugins as Derby release artifacts

    Details

    • Type: Task Task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.9.1.0
    • Fix Version/s: 10.8.3.0
    • Component/s: Eclipse Plug-in
    • Labels:
      None
    • Urgency:
      Normal

      Description

      A consensus has developed that we should stop building the Eclipse plugins as part of Derby releases. 10.8.2 will be the last release which includes these artifacts. After that, people who depend on these plugins will need to build them themselves and, if possible, find a place to publish the plugins. This topic has been discussed on the following email threads:

      http://old.nabble.com/Eclipse-plugins-to31524444.html#a31524444

      http://old.nabble.com/draft-of-message-to-derby-user-concerning-the-future-of-the-Eclipse-plugins-to31691740.html#a31691740

      http://old.nabble.com/future-of-the-Derby-Eclipse-plugins-to31708734.html#a31708734

      This issue tracks tasks needed to accomplish this goal.

      1. derby-5272-01-aa-blurbOnDownloadPage.diff
        4 kB
        Rick Hillegas
      2. derby-5272-02-aa-removeFromReleaseScript.diff
        3 kB
        Rick Hillegas
      3. DERBY-5272_site.stat
        9 kB
        Myrna van Lunteren
      4. DERBY-5272_site.diff
        1.33 MB
        Myrna van Lunteren
      5. derby_plugin.html
        14 kB
        Myrna van Lunteren
      6. DERBY-5272_site.diff2
        178 kB
        Myrna van Lunteren
      7. DERBY-5272_site.stat2
        2 kB
        Myrna van Lunteren

        Activity

        Hide
        Rick Hillegas added a comment -

        Attaching derby-5272-01-aa-blurbOnDownloadPage.diff, a patch which adds a blurb to the top level download page. The blurb alerts users to the fact that we intend to stop building Eclipse plugins after release 10.8.2. The blurb also asks for volunteers to build and host the plugins somewhere else. Committed at subversion revision 1134396.

        Touches the following files:

        M build/site/derby_downloads.html
        M src/documentation/content/xdocs/derby_downloads.xml

        Show
        Rick Hillegas added a comment - Attaching derby-5272-01-aa-blurbOnDownloadPage.diff, a patch which adds a blurb to the top level download page. The blurb alerts users to the fact that we intend to stop building Eclipse plugins after release 10.8.2. The blurb also asks for volunteers to build and host the plugins somewhere else. Committed at subversion revision 1134396. Touches the following files: M build/site/derby_downloads.html M src/documentation/content/xdocs/derby_downloads.xml
        Hide
        Rick Hillegas added a comment -

        Attaching derby-5272-02-aa-removeFromReleaseScript.diff. This patch removes the generation of eclipse plugins from the top level release script.

        I did not remove the target which actually generates the plugin. I don't think we should remove that target unless we are sure that it's useless to the eclipse community.

        We agreed that 10.8.2 was the last release which would carry eclipse plugins. I ported the patch to 10.8 because we may vet a 10.8.3 release later this year. I do not intend to port this fix to any other branches. No-one builds releases from the 10.7 branch and the top-level release script is only useful from that release forward.

        Committed to the trunk at subversion revision 1345254.

        Ported to 10.9 branch at subversion revision 1345261.

        Ported to 10.8 branch at subversion revision 1345264.

        Touches the following file:

        M build.xml

        Show
        Rick Hillegas added a comment - Attaching derby-5272-02-aa-removeFromReleaseScript.diff. This patch removes the generation of eclipse plugins from the top level release script. I did not remove the target which actually generates the plugin. I don't think we should remove that target unless we are sure that it's useless to the eclipse community. We agreed that 10.8.2 was the last release which would carry eclipse plugins. I ported the patch to 10.8 because we may vet a 10.8.3 release later this year. I do not intend to port this fix to any other branches. No-one builds releases from the 10.7 branch and the top-level release script is only useful from that release forward. Committed to the trunk at subversion revision 1345254. Ported to 10.9 branch at subversion revision 1345261. Ported to 10.8 branch at subversion revision 1345264. Touches the following file: M build.xml
        Hide
        Bryan Pendleton added a comment -

        If someone wishes to build the plug-in for themselves, where are the instructions
        for doing this? Are they here: http://db.apache.org/derby/integrate/Readme.html

        Or is there a newer version of these instructions?

        Show
        Bryan Pendleton added a comment - If someone wishes to build the plug-in for themselves, where are the instructions for doing this? Are they here: http://db.apache.org/derby/integrate/Readme.html Or is there a newer version of these instructions?
        Hide
        Rick Hillegas added a comment -

        Hi Myrna, can you answer Bryan's question? Thanks.

        Show
        Rick Hillegas added a comment - Hi Myrna, can you answer Bryan's question? Thanks.
        Hide
        Myrna van Lunteren added a comment - - edited

        Thank you Bryan, for finding those instructions - they are now outdated since we don't make the core plugin anymore, and those instructions assume it is part of the distribution. I'll update that page.

        The instructions for building the plugin are in the derby tree,
        http://svn.apache.org/viewvc/db/derby/code/trunk/plugins/eclipse/Readme.txt?view=markup

        It's possible those instructions aren't applicable to the latest Eclipse versions, I think I last used Eclipse 3.6, and I've found in the past that the eclipse versions differ slightly (check buttons moved, added, removed, or getting different text) in this area from one version to the next. I don't intent to experiment and update the instructions for any newer versions of eclipse, but if someone ever contributes those details, I'm sure that will be appreciated.

        Show
        Myrna van Lunteren added a comment - - edited Thank you Bryan, for finding those instructions - they are now outdated since we don't make the core plugin anymore, and those instructions assume it is part of the distribution. I'll update that page. The instructions for building the plugin are in the derby tree, http://svn.apache.org/viewvc/db/derby/code/trunk/plugins/eclipse/Readme.txt?view=markup It's possible those instructions aren't applicable to the latest Eclipse versions, I think I last used Eclipse 3.6, and I've found in the past that the eclipse versions differ slightly (check buttons moved, added, removed, or getting different text) in this area from one version to the next. I don't intent to experiment and update the instructions for any newer versions of eclipse, but if someone ever contributes those details, I'm sure that will be appreciated.
        Hide
        Myrna van Lunteren added a comment -

        Attaching a patch which removes the plugin details from the web site, and simplifies the references.
        It seemed the on-line help was actually copied into the web site.

        After building the site, I had one problem:
        as a result of removing the outdated pages, the various release pages were also modified, because the menu is the same as for the 'Resources' Tab. For most versions that seems ok (I looked at 10.8.2.1 and 10.7).

        But 10.9.1.0 and 10.8.2.2 are referenced as .cgi files, and they didn't get created for me. Anyone know how to handle this?

        Show
        Myrna van Lunteren added a comment - Attaching a patch which removes the plugin details from the web site, and simplifies the references. It seemed the on-line help was actually copied into the web site. After building the site, I had one problem: as a result of removing the outdated pages, the various release pages were also modified, because the menu is the same as for the 'Resources' Tab. For most versions that seems ok (I looked at 10.8.2.1 and 10.7). But 10.9.1.0 and 10.8.2.2 are referenced as .cgi files, and they didn't get created for me. Anyone know how to handle this?
        Hide
        Myrna van Lunteren added a comment -

        Attaching a new version of the patch.

        When I looked closer at the release pages, I noticed there were references to the plugin_help documentation in the web site on the release pages for releases that had a plugin, and my removing those details would cause broken links.

        As far as I can see, the plugin_help directory on the web site is a copy of the topics under http://svn.apache.org/viewvc/db/derby/code/trunk/plugins/eclipse/org.apache.derby.plugin.doc/topics/.
        It's a pity we have this duplication of information, but it isn't much out of date - the only difference being the changes resulting from DERBY-2376 (revision 531595: http://svn.apache.org/viewvc?view=revision&revision=531595).

        So this second patch doesn't actually remove the old files, instead, it adds a new page, derby_plugin_info, which is referenced in the new updated menu. This way, when going into the Downloads tab and picking one of the releases that had a plugin available, users can still go to the help, and then get the same information as before via the menu, which is still expanded for those pages.

        I also forgot to svn revert a couple of png files in the first patch.

        Re the cgi vs. html for 10.9.1 and 10.8.2.2 - I looked at the release publication page where the creation of these files is described, and I think it's ok that I don't get changes to the .cgi files, and that the mirrorring doesn't work when I'm just opening the files on my machine in the browser.

        Show
        Myrna van Lunteren added a comment - Attaching a new version of the patch. When I looked closer at the release pages, I noticed there were references to the plugin_help documentation in the web site on the release pages for releases that had a plugin, and my removing those details would cause broken links. As far as I can see, the plugin_help directory on the web site is a copy of the topics under http://svn.apache.org/viewvc/db/derby/code/trunk/plugins/eclipse/org.apache.derby.plugin.doc/topics/ . It's a pity we have this duplication of information, but it isn't much out of date - the only difference being the changes resulting from DERBY-2376 (revision 531595: http://svn.apache.org/viewvc?view=revision&revision=531595 ). So this second patch doesn't actually remove the old files, instead, it adds a new page, derby_plugin_info, which is referenced in the new updated menu. This way, when going into the Downloads tab and picking one of the releases that had a plugin available, users can still go to the help, and then get the same information as before via the menu, which is still expanded for those pages. I also forgot to svn revert a couple of png files in the first patch. Re the cgi vs. html for 10.9.1 and 10.8.2.2 - I looked at the release publication page where the creation of these files is described, and I think it's ok that I don't get changes to the .cgi files, and that the mirrorring doesn't work when I'm just opening the files on my machine in the browser.
        Hide
        Myrna van Lunteren added a comment -

        I decided to commit the patch to the web site - with revision 1399759 (http://svn.apache.org/viewvc?view=revision&revision=1399759).

        Is there more work needed here?

        Show
        Myrna van Lunteren added a comment - I decided to commit the patch to the web site - with revision 1399759 ( http://svn.apache.org/viewvc?view=revision&revision=1399759 ). Is there more work needed here?
        Hide
        Rick Hillegas added a comment -

        Thanks, Myrna. I'm not aware of more work which needs to be done. But I'm not an Eclipse user so my opinion is of limited value. Thanks.

        Show
        Rick Hillegas added a comment - Thanks, Myrna. I'm not aware of more work which needs to be done. But I'm not an Eclipse user so my opinion is of limited value. Thanks.
        Hide
        Myrna van Lunteren added a comment -

        I'm resolving this issue, as we're no longer automatically building the core plugins as part of generating the release artifacts, and not building the ui/doc plugin was always a separate manual step.
        The web site has been adjusted so it still lists the plugin in the menu for references from the older releases where we did have them, but more limited for all other pages.
        Assigning to Rick, as he did the actual work of removing the build step from the releases.

        Show
        Myrna van Lunteren added a comment - I'm resolving this issue, as we're no longer automatically building the core plugins as part of generating the release artifacts, and not building the ui/doc plugin was always a separate manual step. The web site has been adjusted so it still lists the plugin in the menu for references from the older releases where we did have them, but more limited for all other pages. Assigning to Rick, as he did the actual work of removing the build step from the releases.

          People

          • Assignee:
            Unassigned
            Reporter:
            Rick Hillegas
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development