Repository navigation
Public release UX: latest downloads, vendor-neutral docs, Linux AppImage and Windows install tooling #301
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
masarray
merged 4 commits into
main
from
docs/release-latest-installers-win-linux-winget-20261024
Oct 24, 2026
Merged
Public release UX: latest downloads, vendor-neutral docs, Linux AppImage and Windows install tooling #301
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
647f808
feat(distribution): latest release onboarding, Linux AppImage CI, Win…
masarray 6ff68f2
fix(ci): separate Linux release upload into permissions-scoped gated job
masarray b9eca0a
fix(linux): use supported Qt 6.10 linux_gcc_64 kit and matching AppIm…
masarray 746126f
ci(winget): dispatchable verified manifest generation and review arti…
masarray File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| name: ARStack Studio Linux AppImage | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'apps/arstack_studio/**' | ||
| - '.github/workflows/arstack-studio-linux-appimage.yml' | ||
| - 'scripts/install-linux.sh' | ||
| workflow_dispatch: | ||
| inputs: | ||
| release_tag: | ||
| description: 'Existing GitHub release tag to build, test and attach Linux AppImage; blank = build artifact only' | ||
| required: false | ||
| type: string | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| appimage: | ||
| name: Build and test Linux x86_64 package | ||
| runs-on: ubuntu-22.04 | ||
| timeout-minutes: 55 | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.event_name == 'workflow_dispatch' && inputs.release_tag != '' && inputs.release_tag || github.sha }} | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Confirm release identity before packaging | ||
| if: ${{ inputs.release_tag != '' }} | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| TAG: ${{ inputs.release_tag }} | ||
| run: | | ||
| set -euo pipefail | ||
| test "$(git rev-parse HEAD)" = "$(git rev-parse "$TAG^{commit}")" | ||
| gh release view "$TAG" --json isDraft,isPrerelease -q 'select(.isDraft==false and .isPrerelease==false)' > release-check.json | ||
| test -s release-check.json | ||
|
|
||
| - name: Install Linux native dependencies | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y --no-install-recommends cmake ninja-build build-essential \ | ||
| libgl1-mesa-dev libxkbcommon-x11-0 libxcb-cursor0 libxcb-xinerama0 \ | ||
| libxcb-xkb1 libxcb-randr0 libxcb-image0 libxcb-keysyms1 libxcb-render-util0 \ | ||
| libfuse2 unzip xvfb libdbus-1-3 | ||
|
|
||
| - name: Install Qt 6 | ||
| uses: jurplel/install-qt-action@v4 | ||
| with: | ||
| version: '6.10.3' | ||
| arch: linux_gcc_64 | ||
| modules: 'qtserialport' | ||
| cache: true | ||
|
|
||
| - name: Compile native Linux Studio and smoke test | ||
| run: | | ||
| set -euo pipefail | ||
| cmake -S apps/arstack_studio -B build-studio-linux -G Ninja \ | ||
| -DCMAKE_BUILD_TYPE=Release -DARIEC61850_WARNINGS_AS_ERRORS=ON | ||
| cmake --build build-studio-linux --target arstack_studio --parallel 2 | ||
| test -x build-studio-linux/arstack_studio | ||
| QT_QPA_PLATFORM=offscreen xvfb-run -a build-studio-linux/arstack_studio --check-reference-template | ||
| QT_QPA_PLATFORM=offscreen xvfb-run -a build-studio-linux/arstack_studio --check-p0-policy | ||
|
|
||
| - name: Stage Linux app and matched optional release firmware | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| TAG: ${{ inputs.release_tag }} | ||
| run: | | ||
| set -euo pipefail | ||
| mkdir -p AppDir/usr/bin AppDir/usr/share/icons/hicolor/512x512/apps | ||
| cp build-studio-linux/arstack_studio AppDir/usr/bin/ARStackStudio | ||
| cp assets/studio_icon/android-chrome-512x512.png AppDir/usr/share/icons/hicolor/512x512/apps/arstack-studio.png | ||
| cat > arstack-studio.desktop <<'DESKTOP' | ||
| [Desktop Entry] | ||
| Type=Application | ||
| Name=ARStack Studio | ||
| Exec=ARStackStudio | ||
| Icon=arstack-studio | ||
| Categories=Education;Science;Electronics; | ||
| Terminal=false | ||
| DESKTOP | ||
| cp LICENSE NOTICE COPYRIGHT.md THIRD_PARTY_NOTICES.md AppDir/usr/bin/ | ||
| if [ -n "$TAG" ]; then | ||
| mkdir -p release-firmware AppDir/usr/bin/firmware AppDir/usr/bin/tools | ||
| gh release download "$TAG" --dir release-firmware --pattern 'firmware-manifest.json' --pattern '*.bin' | ||
| python3 - <<'PY' | ||
| import hashlib,json,pathlib,shutil | ||
| root=pathlib.Path('release-firmware') | ||
| manifest=json.loads((root/'firmware-manifest.json').read_text()) | ||
| binfiles=list(root.glob('*.bin')) | ||
| assert len(binfiles)==1 and manifest['chip']=='esp32p4', 'Release firmware ambiguity' | ||
| src=binfiles[0] | ||
| assert hashlib.sha256(src.read_bytes()).hexdigest()==manifest['sha256'], 'Firmware hash mismatch' | ||
| output=pathlib.Path('AppDir/usr/bin/firmware') | ||
| shutil.copy2(src,output/manifest['image']) | ||
| shutil.copy2(root/'firmware-manifest.json',output/'firmware-manifest.json') | ||
| (output/'SHA256SUMS.txt').write_text(f"{manifest['sha256']} {manifest['image']}\n") | ||
| PY | ||
| curl -fLsS https://github.com/esp-rs/espflash/releases/download/v4.5.0/espflash-x86_64-unknown-linux-gnu.zip -o espflash.zip | ||
| echo 'dcd7fd822f247df18966935bbb10c7cb4b700c87172349633e9e323ee2542717 espflash.zip' | sha256sum -c - | ||
| unzip -j espflash.zip 'espflash' -d AppDir/usr/bin/tools | ||
| chmod +x AppDir/usr/bin/tools/espflash | ||
| fi | ||
|
|
||
| - name: Bundle Qt and create single-file AppImage | ||
| uses: miurahr/install-linuxdeploy-action@v1.8.0 | ||
| id: linuxdeploy | ||
| with: | ||
| plugins: qt appimage | ||
|
|
||
| - name: Generate AppImage and release checksum | ||
| env: | ||
| QML_SOURCES_PATHS: ${{ github.workspace }}/apps/arstack_studio/qml | ||
| VERSION: ${{ inputs.release_tag || 'preview' }} | ||
| run: | | ||
| set -euo pipefail | ||
| export QMAKE="$(command -v qmake6 || command -v qmake)" | ||
| ${{ steps.linuxdeploy.outputs.linuxdeploy }} \ | ||
| --appdir AppDir \ | ||
| --executable AppDir/usr/bin/ARStackStudio \ | ||
| --desktop-file arstack-studio.desktop \ | ||
| --icon-file AppDir/usr/share/icons/hicolor/512x512/apps/arstack-studio.png \ | ||
| --plugin qt --output appimage | ||
| shopt -s nullglob | ||
| images=( ./*.AppImage ) | ||
| test "${#images[@]}" -eq 1 | ||
| mv "${images[0]}" ARStack-Studio-linux-x86_64.AppImage | ||
| chmod +x ARStack-Studio-linux-x86_64.AppImage | ||
| APPIMAGE_EXTRACT_AND_RUN=1 QT_QPA_PLATFORM=offscreen \ | ||
| xvfb-run -a ./ARStack-Studio-linux-x86_64.AppImage --check-reference-template | ||
| sha256sum ARStack-Studio-linux-x86_64.AppImage > ARStack-Studio-linux-x86_64.sha256 | ||
|
|
||
| - name: Upload reviewed Linux artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: arstack-studio-linux-x86_64 | ||
| path: | | ||
| ARStack-Studio-linux-x86_64.AppImage | ||
| ARStack-Studio-linux-x86_64.sha256 | ||
| if-no-files-found: error | ||
| retention-days: 14 | ||
|
|
||
| attach-verified-release: | ||
| name: Attach tested Linux package to exact release tag | ||
| needs: appimage | ||
| if: ${{ github.event_name == 'workflow_dispatch' && inputs.release_tag != '' }} | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ inputs.release_tag }} | ||
| fetch-depth: 0 | ||
| - name: Download Linux build that passed the AppImage checks | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: arstack-studio-linux-x86_64 | ||
| - name: Verify tag and release before publishing | ||
| env: | ||
| GH_TOKEN: ${{ github.token }} | ||
| TAG: ${{ inputs.release_tag }} | ||
| run: | | ||
| set -euo pipefail | ||
| test "$(git rev-parse HEAD)" = "$(git rev-parse "$TAG^{commit}")" | ||
| gh release view "$TAG" --json isDraft,isPrerelease -q 'select(.isDraft==false and .isPrerelease==false)' > release-check.json | ||
| test -s release-check.json | ||
| sha256sum -c ARStack-Studio-linux-x86_64.sha256 | ||
| gh release upload "$TAG" \ | ||
| ARStack-Studio-linux-x86_64.AppImage \ | ||
| ARStack-Studio-linux-x86_64.sha256 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| name: ARStack Studio WinGet Manifest | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'scripts/generate_winget_manifest.py' | ||
| - 'docs/INSTALL.md' | ||
| - '.github/workflows/arstack-winget-manifest.yml' | ||
| workflow_dispatch: | ||
| inputs: | ||
| package_version: | ||
| description: 'Unique WinGet package version, e.g. 0.2.0' | ||
| required: true | ||
| type: string | ||
| release_tag: | ||
| description: 'Published and verified GitHub stable release tag' | ||
| required: true | ||
| type: string | ||
| installer_type: | ||
| description: 'Match the actual installer technology for that release' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - inno | ||
| - nullsoft | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| validate-generator: | ||
| name: Validate WinGet manifest generation tool | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 5 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Check Python generator | ||
| run: | | ||
| python3 -m py_compile scripts/generate_winget_manifest.py | ||
| python3 scripts/generate_winget_manifest.py --help | ||
|
|
||
| prepare-manifest: | ||
| name: Generate exact verified installer manifests | ||
| needs: validate-generator | ||
| if: ${{ github.event_name == 'workflow_dispatch' }} | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 10 | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Generate manifest using published installer SHA-256 | ||
| env: | ||
| PACKAGE_VERSION: ${{ inputs.package_version }} | ||
| RELEASE_TAG: ${{ inputs.release_tag }} | ||
| INSTALLER_TYPE: ${{ inputs.installer_type }} | ||
| run: | | ||
| set -euo pipefail | ||
| python3 scripts/generate_winget_manifest.py \ | ||
| --version "$PACKAGE_VERSION" \ | ||
| --tag "$RELEASE_TAG" \ | ||
| --installer-type "$INSTALLER_TYPE" | ||
| grep -R 'InstallerSha256: [0-9A-F]\{64\}' dist/winget | ||
|
|
||
| - uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: arstack-studio-winget-manifests | ||
| path: dist/winget/ | ||
| if-no-files-found: error | ||
| retention-days: 30 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new AppImage workflow runs on Ubuntu 22.04 but installs the official Qt 6.10.3
gcc_64binaries. Qt's supported-platform documentation states that these binaries are built on Ubuntu 24.04 with glibc 2.39 and require rebuilding from source on older glibc versions; Ubuntu 22.04 provides glibc 2.35. Consequently, the Qt build tools and linked Studio executable cannot run on this runner, preventing both PR artifact creation and release publication before packaging completes. Use Ubuntu 24.04 or build a compatible Qt distribution from source.Useful? React with 👍 / 👎.