search

petr-panteleyev / jpackage-maven-plugin

JPackage Maven Plugin
https://codeberg.org/petr-panteleyev/jpackage-maven-plugin
BSD 2-Clause "Simplified" License
37 stars 8 forks source link

Documentation is giving invalid information #13

Closed Lonzak closed 5 months ago

Lonzak commented 5 months ago

Thank you for the plugin! I tried it out however something is not right with the documentation. I tried the description given here however it is using an invalid syntax:

<project>
    <profiles>
        <profile>
            <id>win</id>
            <activation>
                <os>
                    <family>windows</family>
                </os>
            </activation>

->ERROR: <plugins> tag is not allowed in a profile:
              <plugins>
                <plugin>
                    <groupId>org.panteleyev</groupId>
                    <artifactId>jpackage-maven-plugin</artifactId>
                    <version>1.4.0</version>
                    ...
                </plugin>
            </plugins>
        </profile>

A surrounding <build></build> was missing. So it should be:

<project>
    <profiles>
        <profile>
            <id>win</id>
            <activation>
                <os>
                    <family>windows</family>
                </os>
            </activation>
                <build>
                      <plugins>
                          <plugin>
                              <groupId>org.panteleyev</groupId>
                              <artifactId>jpackage-maven-plugin</artifactId>
                              <version>1.4.0</version>

                              <configuration>
                                  <icon>icons/icons.ico</icon>
                                  <winMenu>true</winMenu>
                              </configuration>
                          </plugin>
                      </plugins>
              </build>
        </profile>
        <profile>
            <id>mac</id>
            <activation>
                <os>
                    <family>mac</family>
                </os>
            </activation>
            <build>
              <plugins>
                  <plugin>
                      <groupId>org.panteleyev</groupId>
                      <artifactId>jpackage-maven-plugin</artifactId>
                      <version>1.4.0</version>

                      <configuration>
                          <icon>icons/icons.icns</icon>
                      </configuration>
                  </plugin>
              </plugins>
           </build>
        </profile>
    </profiles>

    <build>
        <plugins>
            <plugin>
                <groupId>org.panteleyev</groupId>
                <artifactId>jpackage-maven-plugin</artifactId>
                <version>1.4.0</version>

                <!-- Common part of configuration -->
                <configuration>
                    <name>Application Name</name>
                    <appVersion>${project.version}</appVersion>
                    <vendor>app.org</vendor>
                    <module>${appModule}/${appMainClass}</module>
                    <modulePaths>
                        <modulePath>target/mods</modulePath>
                    </modulePaths>
                    <destination>target/dist</destination>
                    <javaOptions>
                        <option>--enable-preview</option>
                        <option>-Dfile.encoding=UTF-8</option>
                    </javaOptions>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>
petr-panteleyev commented 5 months ago

Thanks for noticing, fixed.

Lonzak commented 5 months ago

I think you forgot to update one version:

Twice:

<groupId>org.panteleyev</groupId>
<artifactId>jpackage-maven-plugin</artifactId>
<version>1.6.3</version>

at the bottom:

<groupId>org.panteleyev</groupId>
<artifactId>jpackage-maven-plugin</artifactId>
<version>1.4.0</version>

should be 1.6.3 as well...

Lonzak commented 5 months ago

I think it would be nice to add linux profile as well:

      <profile>
            <id>unix</id>
            <activation>
                <os>
                    <family>unix</family>
                </os>
            </activation>
             <build>
                <plugins>
                    <plugin>
                        <groupId>org.panteleyev</groupId>
                        <artifactId>jpackage-maven-plugin</artifactId>
                        <version>1.6.3</version>
                        <configuration>
                <icon>icons/icons.png</icon>
                        </configuration>
                    </plugin>
                </plugins>
          </build>
        </profile>