hydraulic-software / conveyor

Gradle plugin, user guide and discussion forums for Conveyor
https://conveyor.hydraulic.dev
Apache License 2.0
123 stars 10 forks source link

The version in generated appcast-*.rss does not match the defined app.version #118

Closed guiyanakuang closed 2 weeks ago

guiyanakuang commented 4 months ago

Describe the bug When running gradlew -q printConveyorConfig, the output is:

.....
app.version = 1.0.0
.....

However, the generated appcast-amd64.rss file

<rss xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle" xmlns:dc="http://purl.org/dc/elements/1.1/" version="2.0">
    <channel>
        <title>Changelog</title>
        <link>http://localhost:3000/appcast-amd64.rss</link>
        <description>Most recent changes with links to updates.</description>
        <language>en</language>
        <item>
            <title>Version 1.0.0.0</title>
            <link>http://localhost:3000/</link>
            <sparkle:version>1.0.0.0</sparkle:version>
            <description>
                <![CDATA[ New release: version 1.0.0.0 ]]>
            </description>
            ........
        </item>
    </channel>
</rss>

The version in the appcast-amd64.rss is 1.0.0.0, which does not match the defined app.version of 1.0.0.

Additional context

mikehearn commented 4 months ago

That's intentional. The last number comes from the app.revision key, which is intended to be used if you change the packaging configuration but not the underlying code. The idea is that the revision number can be hidden in the app UI. same thing is done on Windows. It's useful when packaging other people's software for example, as the 4th digit normally isn't used.

guiyanakuang commented 4 months ago

However, Sparkle will use this combined version number and display it in the upgrade UI, which I am concerned might confuse users. Users generally do not care about the revision number.

If it would be possible to customize the <title>Version 1.0.0.0</title> (including the release title), that would be great. The version 1.0.0.0 does not conform to the semver syntax and looks quite odd.

mikehearn commented 2 weeks ago

The fix for this should go out in the next minor release, thanks for the suggestion!