update everything (#8)

Author: Merrit

.devcontainer/Dockerfile

@@ -0,0 +1,28 @@
+FROM mcr.microsoft.com/devcontainers/base:ubuntu-20.04
+
+
+# ------------------------ Prepare docker environment ------------------------ #
+
+RUN apt-get update
+
+# Install general utilities
+RUN apt-get -y install tree
+
+# Install Flutter dependencies
+RUN apt-get -y install curl file git unzip xz-utils zip clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev
+# Install app-specific dependencies
+RUN apt-get -y install keybinder-3.0 appindicator3-0.1 libappindicator3-1 libappindicator3-dev
+
+# Install Flutter
+RUN git clone https://github.com/flutter/flutter.git -b stable /home/vscode/flutter
+RUN git config --global --add safe.directory /home/vscode/flutter
+ENV PATH="$PATH:/home/vscode/flutter/bin"
+RUN flutter upgrade
+RUN chown -R vscode:vscode /home/vscode/flutter
+
+# Prepare environment for building Flatpak
+RUN apt-get install -y flatpak flatpak-builder
+RUN flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
+RUN flatpak install -y org.freedesktop.Sdk/x86_64/22.08
+RUN flatpak install -y org.freedesktop.Platform/x86_64/22.08
+RUN flatpak install -y flathub org.freedesktop.appstream-glib

.devcontainer/devcontainer.json

@@ -0,0 +1,35 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
+{
+	"name": "Ubuntu",
+	
+	// "image": "mcr.microsoft.com/devcontainers/base:focal",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+
+	"privileged": true,
+
+	"remoteEnv": {
+		// Add Flutter to the PATH variable.
+		"PATH": "${containerEnv:PATH}:/home/vscode/flutter/bin"
+	}
+}

.github/workflows/flatpak.yml

@@ -11,10 +11,10 @@ env:
 jobs:
   build-flutter-app:
     name: Build and compressed Flutter app
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install Flutter dependencies
         run: |
@@ -23,48 +23,37 @@ jobs:
 
       - name: Setup Flutter
         uses: subosito/flutter-action@v2
-        with:
-          channel: beta
 
       - name: Build Flutter linux version
+        working-directory: ${{ github.workspace }}/counter_app
         run: |
-          flutter config --enable-linux-desktop
-          flutter pub get
-          flutter build linux
-
-      - name: Compress Flutter build
-        run: tar -C build/linux/x64/release/bundle -acvf FlutterApp-Linux-Portable.tar.gz .
+          ./build-flutter-app.sh
 
-      - name: Upload app archive for next steps
-        uses: actions/upload-artifact@v2
+      - name: Upload app archive to workflow
+        uses: actions/upload-artifact@v3
         with:
           name: FlutterApp-Archive
-          path: FlutterApp-Linux-Portable.tar.gz
+          path: counter_app/FlutterApp-Linux-Portable.tar.gz
 
   build-flatpak:
     name: Build flatpak
     needs: build-flutter-app
     runs-on: ubuntu-latest
     container:
-      image: bilelmoussaoui/flatpak-github-actions:freedesktop-21.08
+      image: bilelmoussaoui/flatpak-github-actions:freedesktop-22.08
       options: --privileged
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Download app archive
-        uses: actions/download-artifact@v3
-        with:
-          name: FlutterApp-Archive
+        uses: actions/checkout@v3
 
       - name: Build .flatpak
-        uses: bilelmoussaoui/flatpak-github-actions/flatpak-builder@v4
+        uses: bilelmoussaoui/flatpak-github-actions/flatpak-builder@v5
         with:
           bundle: FlutterApp.flatpak
-          manifest-path: com.example.FlutterApp.json
+          manifest-path: flathub_repo/com.example.FlutterApp.yml
 
       - name: Upload .flatpak artifact to workflow
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: Flatpak artifact
           path: FlutterApp.flatpak

README.md

@@ -1,3 +1,11 @@
+- [Flutter Flatpak Example](#flutter-flatpak-example)
+  - [Requirements](#requirements)
+    - [VSCode dev container](#vscode-dev-container)
+    - [GitHub actions](#github-actions)
+    - [Manual Requirements](#manual-requirements)
+  - [Instructions](#instructions)
+
+
 # Flutter Flatpak Example
 
 
@@ -6,33 +14,32 @@ on Linux, using the default counter example app.
 
 [Flatpak documentation](https://docs.flatpak.org/en/latest/index.html)
 
-The necessary configuration files are in the root of the repository for ease of demonstration:
-
-- `com.example.FlutterApp.desktop` -- desktop menu / icon integration
-- `icon.svg` -- app's icon
-- `com.example.FlutterApp.json` -- Flatpak manifest, instructions on how to build
-  / assemble the flatpak
-- `com.example.FlutterApp.metainfo.xml` -- AppStream metadata file that contains
-  the information about the app that would be presented on an app store like Flathub
 
 
 ## Requirements
 
-- flatpak
-- flatpak-builder
+> Note: Building a flatpak should be done in a predictable environment or it may
+> fail.
 
-On ubuntu:
+[Set up Flathub](https://flatpak.org/setup/), and choose one:
 
-> sudo apt install flatpak flatpak-builder
+### VSCode dev container
 
-Also required: [Flathub setup](https://flatpak.org/setup/)
+Use the VSCode dev container provided in this repo that will run everything
+through Docker
 
+1. Install the [Dev
+   Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+   extension
+   
+2. Open this directory in VSCode.
 
-## Instructions
+3. Accept the prompt to re-open in the dev container, or from the Command
+   Palette search for `Reopen in Container`
+
+
+### GitHub actions
 
-> Note: Building a flatpak should be done in a predictable environment or it may
-> fail.
-> 
 > There is a [GitHub
 > action](https://github.com/bilelmoussaoui/flatpak-github-actions) for this
 > purpose, which is demonstrated in this repo. This action's page also lists the
@@ -42,54 +49,39 @@ Also required: [Flathub setup](https://flatpak.org/setup/)
 > install the `.flatpak` file it generates with `flatpak install <path-to-.flatpak>`.
 
 
-Get Flutter project dependencies:
-
-```
-flutter pub get
-```
-
-
-Build linux version:
-
-```
-flutter build linux
-```
+### Manual Requirements
 
+Install flatpak and flatpak-builder
 
-Compress linux build:
+On ubuntu:
 
-```
-tar -C build/linux/x64/release/bundle -acvf FlutterApp-Linux-Portable.tar.gz .
+```bash
+sudo apt install flatpak flatpak-builder
 ```
 
+Add the FlatHub repo:
 
-Instruct `flatpak-builder` to use the manifest to do a flatpak build:
-
-```
-flatpak-builder --force-clean build-dir com.example.FlutterApp.json
+```bash
+flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
 ```
 
-_Optional:_
+Install flatpak build dependencies:
 
-To build and immediately install the flatpak it produces add `--user --install` to the build command, for example:
-
-```
-flatpak-builder --force-clean build-dir com.example.FlutterApp.json --user --install
+```bash
+flatpak install -y org.freedesktop.Sdk/x86_64/22.08
+flatpak install -y org.freedesktop.Platform/x86_64/22.08
+flatpak install -y flathub org.freedesktop.appstream-glib
 ```
 
-or to create a `.flatpak` file that can later be installed on any system:
-
-```
-flatpak-builder --force-clean build-dir com.example.FlutterApp.json --repo=repo
-flatpak build-bundle repo com.example.FlutterApp.flatpak com.example.FlutterApp
-```
 
-Will generate `com.example.FlutterApp.flatpak`, which can be installed on any system with Flatpak support:
+## Instructions
 
-```
-flatpak install com.example.FlutterApp.flatpak
-```
+We have two directories that each represent what would be separate git
+repositories for a real project:
 
-## Publish to app store
+`counter_app` is the Flutter app, view the README there for info on
+configuration and building.
 
-When this succeeds you can proceed to [submit to an app store like Flathub](https://github.com/flathub/flathub/wiki/App-Submission).
+`flathub_repo` is separate from the Flutter app and is where the Flatpak is
+assembled, view the README there for info on configuration, building, and
+publishing of the flatpak after building the `counter_app`.