CI Questions

[rgleason]

Submodule OpenCPN/opencpn-libs For commands see the Instructions at the bottom.

How do I compile locally? Window, MacOS, Linux

https://opencpn-manuals.github.io/main/opencpn-dev/index.html find Compiling
https://opencpn-manuals.github.io/main/opencpn-dev/linux.html
https://opencpn-manuals.github.io/main/opencpn-dev/mac-osx.html
https://opencpn-manuals.github.io/main/opencpn-dev/windows.html
https://opencpn-manuals.github.io/main/opencpn-dev/linux.html#_flatpak

Update Process

• Support plugins maintained by package managers
• Make PR from all authors sites first and resolve any conflicts and commit the changes.
• Then make a PR back to the author's website which will collect all subsequent commits.
• Update to wxWidgets 3.2.2 - Dave says no need to until v5.10
• Update to api118 and update the opencpn-lib modules
• Note: Move from API 117 to API118 with v5.10 not necessary, but desireable See Jon's directions for move to 118 -

Using API 118

CMakeLists.txt line 63 approx

set(OCPN_API_VERSION_MAJOR "1")
set(OCPN_API_VERSION_MINOR "18")

CMakeLists.txt line 206 approx

    add_subdirectory(opencpn-libs/api-18)
    target_link_libraries(${PACKAGE_NAME} ocpn::api)

main_plugin_pi.h line 49 approx

class polar_pi : public opencpn_plugin_118
{
public:

main_plugin_pi.h line 100 approx

    int GetPlugInVersionPatch();
    int GetPlugInVersionPost();

main_plugin_pi.cpp line 60 approx

polar_pi::polar_pi(void *ppimgr)
      :opencpn_plugin_118(ppimgr)

main_plugin_pi.cpp Line 217 and 222

int polar_pi::GetPlugInVersionPatch()   {   return PLUGIN_VERSION_PATCH;}
int polar_pi::GetPlugInVersionPost() {      return PLUGIN_VERSION_TWEAK;}

Shipdriver_pi.cpp UPDATE_PLUGIN.md Shipdriver uses these GetPluginVersionPre and GetPluginVersionBuild to display, but TP templates don't

int GetPlugInVersionPatch() { return PLUGIN_VERSION_PATCH; }
int GetPlugInVersionPost() { return PLUGIN_VERSION_TWEAK; }
const char *GetPlugInVersionPre() { return PKG_PRERELEASE; }
const char *GetPlugInVersionBuild() { return PKG_BUILD_INFO; }

flatpak-aarch64-24.08 build info

• provisional build to support flatpak-runtime 24.08, whenever we migrate the OCPN core to this version
• OCPN core 5.10.2 Production today runs flatpak 22.08, mainly because 24.08 was not stable when O5.10.2 was released.
• Tentatively, core will be moved to 24.08 on release of OCPN 5.12.x
• it is sufficient to know that the flatpak 24.08 plugins actually build in CCI, but there is no reason to deploy them into the catalog today. No-one can use them. No current OCPN version calls for them.

[rgleason]

5.10 is here, should we be doing these?

• Update to wxWidgets 3.2.2 - Dave says no need to until v5.10
• Upgrade to API 118 for OpenCPN 5.10
  • Change 1.17 to 1.18 in CMakeLists.txt
  • Change 117 to 118 in [plugin_pi.cpp] around line 91
• Move from API 117 to API118 with v5.10 not necessary, but desireable Give us improved version numbering. Need to change some code in each plugin.

[jongough]

Upgrading testplugin to 118 in version 1.0.308.0. This will require two changes in the CMakeLists.txt file

• Change the line set(OCPN_API_VERSION_MINOR "17") to set(OCPN_API_VERSION_MINOR "18")
• Change the line add_subdirectory(opencpn-libs/api-17) to add_subdirectory(opencpn-libs/api-18)

Then the main cpp file will need to be based on 118
change

testplugin_pi::testplugin_pi(void *ppimgr)
:opencpn_plugin_117(ppimgr)

to

testplugin_pi::testplugin_pi(void *ppimgr)
:opencpn_plugin_118(ppimgr)

and in the header file change class testplugin_pi : public opencpn_plugin_117 to `class testplugin_pi : public opencpn_plugin_118'

These should reflect the plugin name not testplugin.

[rgleason]

That is a great help, Thank you Jon. I missed a couple of things (got the first and third changes).
What/where is the "header" file with the "class"

[jongough]

The plugin header, in FE2's case - testplugin_pi.h, so just look in the requisite header file for the plugin where it defines the plugin class.

[rgleason]

Thanks, found it here in your commits . I am rusty!
0f0db24

[rgleason]

DONE

• Local and CI tarballs include metadata.xml - Done
• CI: Update old android builds (near future) #366 Yes Done
• CI: Docker Android image being deprecated (near future) #355 Yes. Done
• CI: Bookworm fix (near future) #364 Done.
• #3223 Yes Done
• CI: Flatpak and use of common opencpn-libs (near future) #365 Some discussion about packaging for plugins.
• CI: Stop building OpenCPN 5.6.2 PI next major update? (near future) #368 ? Yes. v5.10 Done
• Drop OpenCPN 5.6.2 builds when v5.10 comes out. See template table - Done
• Drop Buster and Bionic Builds - When v5.10 comes out. (these are used for O5.6.2) -Done
• Upgrade to API 118 for OpenCPN 5.10 Not tet neccessarily.

[rgleason]

@jongough
Please refer to this weather_routing issue to learn more about Collaborators pushing tarball/metadata up to CS.io/[plugin]-alpha and CS.io/[plugin]-beta

rgleason/weather_routing_pi#290 (comment)