Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-2557

Configure Genoviz SDK POM for submission to Maven Central

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Critical
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      1
    • Sprint:
      Fall 3: Oct 12 - Oct 23, Fall 4 Oct 26 - Nov 6, Fall 6 Nov 30 - Dec 11, Fall 7 Dec 14 - Dec 23, Winter 1 Dec 28 - Jan 8

      Description

      Modify genoviz-sdk module POM's to prepare artifacts for upload and distribution at Maven Central.

      See repository link: https://bitbucket.org/lorainelab/genoviz-sdk

      Goals and tasks:

      • Change groupId to org.bioviz
      • Change artifactId to genoviz-sdk
      • Add required items as noted in this video: https://www.youtube.com/watch?v=C-kIh0Mt6sg
      • Add logic to the POM build system to sign the jars, keeping private key private (not checked-in except in a private repository)

        Attachments

          Issue Links

            Activity

            Hide
            ssegu Sai Supreeth Segu (Inactive) added a comment -

            [~aloraine] Do I need to change pom.xml in top level or pom.xml in genoviz-sdk/genoviz_sdk?

            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - [~aloraine] Do I need to change pom.xml in top level or pom.xml in genoviz-sdk/genoviz_sdk?
            Hide
            ann.loraine Ann Loraine added a comment -

            What you need to do (I think?) is make sure that the pom.xml that gets packaged with the library "jar" file includes all the necessary information.

            Show
            ann.loraine Ann Loraine added a comment - What you need to do (I think?) is make sure that the pom.xml that gets packaged with the library "jar" file includes all the necessary information.
            Hide
            ssegu Sai Supreeth Segu (Inactive) added a comment -

            When I try to deploy the Genoviz SDK, I got the following error

            [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project genoviz: MavenReportException: Error while creating archive:
            [ERROR] Exit code: 1 - /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:90: warning: no @param for tel
            [ERROR] public synchronized void addTierEventListener(TierEventListener tel) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:97: warning: no @param for tel
            [ERROR] public synchronized void removeTierEventListener(TierEventListener tel) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:104: warning: no @param for evt
            [ERROR] public synchronized void notifyTierEventListeners(TierEvent evt) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:258: warning: no @param for mtg
            [ERROR] public int indexOf(MapTierGlyph mtg) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:267: warning: no @return
            [ERROR] public MapTierGlyph getTierAt(int i) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:319: warning: no @param for toRemove
            [ERROR] public void removeTier(MapTierGlyph toRemove) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:398: warning: no @param for otherMap
            [ERROR] protected void removeCorrTier(AbstractTieredMap otherMap, MapTierGlyph otherTier) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:398: warning: no @param for otherTier
            [ERROR] protected void removeCorrTier(AbstractTieredMap otherMap, MapTierGlyph otherTier) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:431: warning: no @return
            [ERROR] public boolean isAbleToPackToMatch() {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:438: warning: no @param for b
            [ERROR] public void setAbleToPackToMatch(boolean b) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:450: warning: no @param for otherMap
            [ERROR] protected void packToMatch(AbstractTieredMap otherMap, boolean full_repack, boolean stretch_map) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:450: warning: no @param for full_repack
            [ERROR] protected void packToMatch(AbstractTieredMap otherMap, boolean full_repack, boolean stretch_map) {
            [ERROR] ^
            [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:450: warning: no @param for stretch_map
            [ERROR] protected void packToMatch(AbstractTieredMap otherMap, boolean full_repack, boolean stretch_map) {

            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - When I try to deploy the Genoviz SDK, I got the following error [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project genoviz: MavenReportException: Error while creating archive: [ERROR] Exit code: 1 - /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:90: warning: no @param for tel [ERROR] public synchronized void addTierEventListener(TierEventListener tel) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:97: warning: no @param for tel [ERROR] public synchronized void removeTierEventListener(TierEventListener tel) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:104: warning: no @param for evt [ERROR] public synchronized void notifyTierEventListeners(TierEvent evt) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:258: warning: no @param for mtg [ERROR] public int indexOf(MapTierGlyph mtg) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:267: warning: no @return [ERROR] public MapTierGlyph getTierAt(int i) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:319: warning: no @param for toRemove [ERROR] public void removeTier(MapTierGlyph toRemove) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:398: warning: no @param for otherMap [ERROR] protected void removeCorrTier(AbstractTieredMap otherMap, MapTierGlyph otherTier) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:398: warning: no @param for otherTier [ERROR] protected void removeCorrTier(AbstractTieredMap otherMap, MapTierGlyph otherTier) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:431: warning: no @return [ERROR] public boolean isAbleToPackToMatch() { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:438: warning: no @param for b [ERROR] public void setAbleToPackToMatch(boolean b) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:450: warning: no @param for otherMap [ERROR] protected void packToMatch(AbstractTieredMap otherMap, boolean full_repack, boolean stretch_map) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:450: warning: no @param for full_repack [ERROR] protected void packToMatch(AbstractTieredMap otherMap, boolean full_repack, boolean stretch_map) { [ERROR] ^ [ERROR] /Users/supreeth/Desktop/AMAZON/IGB_work/Genoviz_SDK/genoviz-sdk/genoviz_sdk/src/main/java/com/affymetrix/genoviz/widget/AbstractTieredMap.java:450: warning: no @param for stretch_map [ERROR] protected void packToMatch(AbstractTieredMap otherMap, boolean full_repack, boolean stretch_map) {
            Hide
            ssegu Sai Supreeth Segu (Inactive) added a comment -

            This error generally comes when the code doesn't meet Javadoc standards as per my research. Please look into this link for more detailed discussion: https://stackoverflow.com/questions/23542876/unable-to-build-maven-project-due-to-javadoc-error

            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - This error generally comes when the code doesn't meet Javadoc standards as per my research. Please look into this link for more detailed discussion: https://stackoverflow.com/questions/23542876/unable-to-build-maven-project-due-to-javadoc-error
            Hide
            ssegu Sai Supreeth Segu (Inactive) added a comment -

            I have tried to comment out the Javadoc requirement then I was able to deploy the Genoviz SDK successfully.

            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - I have tried to comment out the Javadoc requirement then I was able to deploy the Genoviz SDK successfully.
            Hide
            ann.loraine Ann Loraine added a comment -

            Just checking:

            You are just testing right now and have not yet actually deployed the artifact to maven central but instead have only deployed to maven central staging. Is that right?

            Please note:

            • this ticket is to prepare the artifact, not actually deploy it (testing is totally fine though)
            • groupId is going to be org.bioviz, not org.lorainelab
            • javadocs are being built and ultimately deployed on bioviz.org already
            Show
            ann.loraine Ann Loraine added a comment - Just checking: You are just testing right now and have not yet actually deployed the artifact to maven central but instead have only deployed to maven central staging. Is that right? Please note: this ticket is to prepare the artifact, not actually deploy it (testing is totally fine though) groupId is going to be org.bioviz, not org.lorainelab javadocs are being built and ultimately deployed on bioviz.org already
            Hide
            ann.loraine Ann Loraine added a comment -

            confirmed: testing is against staging, not maven central

            Show
            ann.loraine Ann Loraine added a comment - confirmed: testing is against staging, not maven central
            Hide
            ssegu Sai Supreeth Segu (Inactive) added a comment -

            I have made changes to pom.xml. I have changed the id to "OSSRH". Please review it.
            Please find the link for the commit: https://bitbucket.org/supreeth27/genoviz-sdk/commits/bcc1e2ca4e7736af40c49d5d967468644e297811
            cc: [~aloraine]

            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - I have made changes to pom.xml. I have changed the id to "OSSRH". Please review it. Please find the link for the commit: https://bitbucket.org/supreeth27/genoviz-sdk/commits/bcc1e2ca4e7736af40c49d5d967468644e297811 cc: [~aloraine]
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            Changes requests:

            (Note: Some of these may already be done in your branch.)

            • artifactID for the tutorial should be "genoviz-tutorial"
            • artifactID for the genoviz library should be "genoviz-sdk"
            Show
            ann.loraine Ann Loraine added a comment - - edited Changes requests: (Note: Some of these may already be done in your branch.) artifactID for the tutorial should be "genoviz-tutorial" artifactID for the genoviz library should be "genoviz-sdk"
            Hide
            ssegu Sai Supreeth Segu (Inactive) added a comment -
            • artifactID for the genoviz library is "genoviz-sdk"
            • artifactID for the genoviz module is "genoviz"
            • artifactID for the genoviz tutorial module is "genovizTutorial"

            Let me know if this is fine or I need to make changes for these artifacts. I believe I need to make a change for genoviz tutorial module only.
            cc: [~aloraine]

            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - artifactID for the genoviz library is "genoviz-sdk" artifactID for the genoviz module is "genoviz" artifactID for the genoviz tutorial module is "genovizTutorial" Let me know if this is fine or I need to make changes for these artifacts. I believe I need to make a change for genoviz tutorial module only. cc: [~aloraine]
            Hide
            ann.loraine Ann Loraine added a comment -

            This is fine. Please submit PR when ready. Thank you!

            Show
            ann.loraine Ann Loraine added a comment - This is fine. Please submit PR when ready. Thank you!
            Show
            ssegu Sai Supreeth Segu (Inactive) added a comment - Please find the link for the pull request: https://bitbucket.org/lorainelab/genoviz-sdk/pull-requests/22/igbf-2557-changes-in-pomxml-for-publishing
            Hide
            ann.loraine Ann Loraine added a comment -

            Merged and then reverted due to Loraine not being able to write to maven central.

            Show
            ann.loraine Ann Loraine added a comment - Merged and then reverted due to Loraine not being able to write to maven central.

              People

              • Assignee:
                ssegu Sai Supreeth Segu (Inactive)
                Reporter:
                ann.loraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: