Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify groovydoc generation #50

Merged
merged 6 commits into from
Feb 23, 2024
Merged

Simplify groovydoc generation #50

merged 6 commits into from
Feb 23, 2024

Conversation

rolnico
Copy link
Member

@rolnico rolnico commented Sep 20, 2023

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem?

No

What kind of change does this PR introduce?

Quality

What is the current behavior?

Use build-helper-maven-plugin to attach groovydoc.

What is the new behavior (if this is a feature change)?
Use gmaven-plusin:groovydoc-jar to attach groovydoc.

Does this PR introduce a breaking change or deprecate an API?

  • The Breaking Change or Deprecated label has been added
  • The migration guide has been updated in the github wiki (What changes might users need to make in their application due to this PR?)

What changes might users need to make in their application due to this PR? (migration steps)

If one of your pom.xml contains a build-helper-maven-plugin execution in order to attach groovydoc with type javadoc:

  • remove this plugin execution;
  • add the property <groovydoc.attach>true</groovydoc.attach>.

For instance:

    <properties>
+        <groovydoc.attach>true</groovydoc.attach>
        <groovydoc.classifier>javadoc</groovydoc.classifier>
    </properties>
<!-- ... -->
    <build>
            <!-- ... -->
            <plugin>
                <groupId>org.codehaus.gmavenplus</groupId>
                <artifactId>gmavenplus-plugin</artifactId>
            </plugin>
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId>
-                <artifactId>build-helper-maven-plugin</artifactId>
-            </plugin>
        </plugins>
    </build>

Other information:

@rolnico rolnico requested a review from jonenst September 20, 2023 12:09
Signed-off-by: Nicolas Rol <nicolas.rol@rte-france.com>
@rolnico rolnico force-pushed the groovydoc_attach_true branch from 5e8218b to 166983e Compare September 20, 2023 12:16
jonenst added a commit to powsybl/powsybl-math-native that referenced this pull request Dec 5, 2023
To be removed when powsybl/powsybl-parent#50 is released

gpg: impossible d'ouvrir « /home/harperjon/Projects/aggregator/backend/libs/powsybl-math-native/target/powsybl-math-native-1.4.0-SNAPSHOT-groovydoc.jar » : Aucun fichier ou dossier de ce type
gpg: signing failed: erreur d'ouverture de fichier

Signed-off-by: HARPER Jon <jon.harper87@gmail.com>
jonenst added a commit to powsybl/powsybl-math-native that referenced this pull request Dec 5, 2023
To be removed when powsybl/powsybl-parent#50 is released

gpg: impossible d'ouvrir « powsybl-math-native/target/powsybl-math-native-1.4.0-SNAPSHOT-groovydoc.jar » : Aucun fichier ou dossier de ce type
gpg: signing failed: erreur d'ouverture de fichier

Signed-off-by: HARPER Jon <jon.harper87@gmail.com>
@jonenst
Copy link
Contributor

jonenst commented Dec 5, 2023

What changes might users need to make in their application due to this PR? (migration steps)

remove build-helper-maven-plugin execution when using it for groovydoc attaching with type javadoc

geofjamg pushed a commit to powsybl/powsybl-math-native that referenced this pull request Dec 5, 2023
To be removed when powsybl/powsybl-parent#50 is released

gpg: impossible d'ouvrir « powsybl-math-native/target/powsybl-math-native-1.4.0-SNAPSHOT-groovydoc.jar » : Aucun fichier ou dossier de ce type
gpg: signing failed: erreur d'ouverture de fichier

Signed-off-by: HARPER Jon <jon.harper87@gmail.com>
Signed-off-by: HARPER Jon <jon.harper87@gmail.com>
…ched by default)

Signed-off-by: Olivier Perrin <olivier.perrin@rte-france.com>
@olperr1 olperr1 added the Breaking change API is broken label Feb 16, 2024
@olperr1 olperr1 merged commit 86e932c into main Feb 23, 2024
2 checks passed
@olperr1 olperr1 deleted the groovydoc_attach_true branch February 23, 2024 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change API is broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants