This is a flatpak for Grayjay Desktop. Please help test and report any issues you find.
- install
flatpak-builder(required) andjust(optional) - run
just buildorflatpak-builder --user --install build-dir app.grayjay.Grayjay.yamlto build the flatpak- there is also the
clean-buildshortcut which adds the--force-cleanarg
- there is also the
- run
just runorflatpak run app.grayjay.Grayjayor open it from your system menu to run the flatpak.
When new grayjay tags come out, here are, at a minimum, the things that should happen to create a new flatpak release:
Prerequisite: Have a local clone of the Grayjay.Desktop source code. It is recommended to set GIT_LFS_SKIP_SMUDGE=1 in your environment variables or otherwise disable git LFS when doing git operations if you dont want to download 6 GB of prebuilt libcef stuff. Cloning the submodules (or running git submodule update --init after cloning) will likely be helpful.
- Verify the metadata has been updated in the main grayjay repo (mostly screenshots, but also release version numbers/dates/changelogs, and any store descriptions that need updating)
- Ensure that the
commitvalue of the first source under thegrayjaymodule in./app.grayjay.Grayjay.yamlhas been updated to the commit hash corresponding to the git tag (or hotfix commit) you want to release. - Run
python3 ./scripts/flatpak-submodules-generator.py <path to your checked out grayjay source repo> <tag name to build, i.e. 7>to updatesubmodule-sources.json - Start a build, and then stop it about 15-20 seconds after the grayjay module starts building. Then run
flatpak-builder --run build-dir ./app.grayjay.Grayjay.yaml ./scripts/npm-deps.sh npm-sources.json /run/build/grayjay/Grayjay.Desktop.Web/package-lock.jsonto update thenpm-sources.json - Run
python3 ./flatpak-builder-tools/dotnet/flatpak-dotnet-generator.py nuget-sources.json <path to your checked out grayjay source repo>/Grayjay.Desktop.sln --freedesktop 24.08 --dotnet 9to updatenuget-sources.json
You should now be able to run just build to completion to make sure everything works or make any adjustments based on what changed in the specific version of Grayjay.
Here is some documentation on building flatpaks that has been helpful
- https://docs.flathub.org/docs/for-app-authors/requirements/
- https://docs.flathub.org/docs/for-app-authors/submission/#before-submission
- https://docs.flathub.org/docs/for-app-authors/requirements/#dependency-manifest
- https://docs.flathub.org/docs/for-app-authors/metainfo-guidelines/
- https://flatpak-docs.readthedocs.io/en/latest/first-build.html
- https://docs.flatpak.org/en/latest/sandbox-permissions.html
Grayjay is licensed under the FUTO Source First License 1.1, a source-available noncommercial license.
Original scripts in this repo are licensed MIT to the extent that they can be (some, such as scripts/flatpak-submodules-generator.py were initially created with generative AI).
These scripts should be marked with SPDX license identifiers. Where not marked, files should be treated as being under the MIT license.