refactor: migrate to starflow #5225

bepri · 2025-01-29T23:04:39Z

Have you followed the guidelines for contributing?
Have you signed the CLA?
Have you successfully run tox run -m lint?
Have you successfully run tox run -e test-py310? (supported versions: py39, py310, py311, py312)

Should be reviewable on a commit-by-commit basis. Comments will be left on individual files explaining why some changes were necessary. As some words of encouragement: about 250 of the file changes were purely from make format!

bepri · 2025-01-29T23:09:32Z

.shellcheckrc

Was meant to be temporary, was almost accidentally forever

bepri · 2025-01-29T23:10:10Z

TESTING.md

Superceded by changes to HACKING.md

bepri · 2025-01-29T23:10:45Z

manual-tests.md

Was more or less all outdated information and references to files that were no longer there

bepri · 2025-01-29T23:11:02Z

runtests.sh

Outdated - referenced files that were no longer there

snapcraft_legacy/internal/common.py

bepri · 2025-01-29T23:14:23Z

tools/environment-setup-local.sh

This file (along with many of the other tools) were either outdated or superceded by the starbase makefile

bepri · 2025-01-29T23:14:39Z

units.py

This file was outdated, from a time before pytest

lengau · 2025-01-30T17:16:26Z

.github/workflows/qa.yaml

+    uses: canonical/starflow/.github/workflows/test-python.yaml@main
+    with:
+      # Snapcraft currently only tests on Python 3.12 on Ubuntu 24.04
+      fast-test-platforms: '["ubuntu-24.04"]'


@sergiusens should we be using self-hosted runners for this or GH-hosted ones?

lengau · 2025-01-30T18:58:59Z

appveyor.yml

Do we even need this file anymore?

requirements-noble.txt

pyproject.toml

mr-cal · 2025-01-31T22:37:46Z

The spread test failures look like inconsequential changes to yaml formatting, so those should be quick fixes.

mr-cal

This is spooky (in a good way). I ran make setup and make test-fast and within a few seconds I was running unit tests.

I have a few nitpicks but overall everything looks great! This will significantly improve developing and lower the barrier to entry for community contributions.

I'm wondering if this PR is a good time to merge starbase's git history into Snapcraft. The advantage of doing this is that subsequent starbase commits can be brought into Snapcraft with small and easy git merges.

mr-cal · 2025-01-31T22:50:36Z

extensions/desktop/kde-neon-6/launcher-specific

@@ -35,7 +35,7 @@ append_dir QML2_IMPORT_PATH "$SNAP_DESKTOP_RUNTIME/lib/$ARCH"
 # Fix locating the QtWebEngineProcess executable
 export QTWEBENGINEPROCESS_PATH="$SNAP_DESKTOP_RUNTIME/usr/lib/qt6/libexec/QtWebEngineProcess"
 # And QtWebEngine's path to resources
-QTWEBENGINE_RESOURCES_PATH="$SNAP_DESKTOP_RUNTIME/usr/share/qt6/resources"
+export QTWEBENGINE_RESOURCES_PATH="$SNAP_DESKTOP_RUNTIME/usr/share/qt6/resources"


Did shellcheck pick this up?

It seems safe and the correct thing to do. I just need to add this to the next release notes.

Yeah, Shellcheck found this and I'm pretty sure this change fixes a bunch of Qt related snap issues

common.mk

requirements-noble.txt

schema/snapcraft.json

snap/snapcraft.yaml

snapcraft_legacy/internal/mountinfo.py

tests/spread/core24-suites/scriptlets/scriptlet-failures/task.yaml

tests/spread/core24/set-version-twice/task.yaml

bepri · 2025-02-03T21:39:26Z

I'm wondering if this PR is a good time to merge starbase's git history into Snapcraft. The advantage of doing this is that subsequent starbase commits can be brought into Snapcraft with small and easy git merges.

That's the plan! I'm leaving that rebase out of this PR until it's time to merge so that the commit history is easier on reviewers.

bepri · 2025-02-06T22:35:31Z

@medubelko If you'd like, the documentation changes on this PR worth reviewing are as follows:

Deleted manual-tests.md, it had a lot of outdated information.
Migrated the little bit of useful information remaining in TESTING.md into HACKING.md and then deleted the former.
Changed the "Code style" listed in the README to "ruff" (very minor, haha)
Created new environment setup instructions to HACKING.md.

Points #2 and #4 are probably the most important to get right here. Let me know if you get any questions!

data_files is deprecated, so changes to common.py compensate for the change needed to remove its use

This commit doesn't remove any entries, it only organizes them into nice categories

The only part of TESTING.md that remained relevant to modern Snapcraft was the information on Spread, which itself was slightly out of date. This migrates that Spread info to HACKING.MD and deletes the rest.

requirements-noble.txt cannot be built by Trivy and there's no reason for us to scan spread tests

bepri self-assigned this Jan 29, 2025