DevNotes_DevGuide_FlatpakReleaseProcess

[WIP] Flatpak Release Process

This is a draft guide on maintaining and publishing the Flatpak release for SasView.

Repo: https://github.com/flathub/org.sasview.sasview

Release on Flathub: https://flathub.org/en/apps/org.sasview.sasview

Prerequisites

Gaining access to the flathub repo

Process

• Check all dependencies match the pinned release dependencies
  • Dependencies are in all six json files in the repo
  • Ensure all pinned versions match each other across all files and match what sasview used in its build
  • SHAs must match - pypi shows the SHAs of all files. The cargo file SHAs must be calculated.
• Create new branch, make all changes and push
• Open PR to trigger a test build
• Correct any issues related to the build (typically due to dependencies, deprecations, and incompatibilities)
• Once build is successful, merge the PR into master to trigger a release on flathub
• Flathub release should update within 48 hours

Troubleshooting

• The build failed
  • Check the error message from the CI logs. If the failure is due to:
  • a package installation, ensure all other files are using the same version of that dependency, and upgrade or roll back the version. Again, all dependency pins for the same package must use the the same version.
  • a deprecation warning, roll the dependency version back to a point where the failure is no longer deprecated.
  • **a
• A merge into main didn't trigger a new release
  • The manifest file in the sasview repo must be updated prior to the release
    • If if wasn't, update it and create a post-release tag (vx.y.z.posta)
  • The release won't upload if the build failed. See the previous troubleshooting bullet to correct this.
  • If both of these are correct, please wait 48 hours. If the flathub page is still not updated, submit an issue to https://github.com/flathub/flathub.