completely reworks first-setup

This moves away from the recipe based approach since it was too inflexible.

Author: taukakao

.github/workflows/build.yml

@@ -18,29 +18,26 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Get the version
-        id: get_version
-        run: echo "{VERSION}={$(cat VERSION)}" >> $GITHUB_OUTPUT
-
       - name: Install build dependencies
         run: |
-          apt install -y debhelper python3 gettext build-essential desktop-file-utils ninja-build meson libadwaita-1-dev make libnm-dev libnma-dev libnma-gtk4-dev
+          apt-get update
+          apt-get build-dep -y .
 
       - name: Build .deb package
         run: |
             dpkg-buildpackage
-            mv ../vanilla-first-setup_*.deb .
+            mv ../vanilla-first-setup_*.deb vanilla-first-setup.deb
 
       - name: Calculate and Save Checksums
         run: |
-          sha256sum vanilla-first-setup_*.deb >> checksums.txt
+          sha256sum vanilla-first-setup.deb >> checksums.txt
 
       - uses: actions/upload-artifact@v4
         with:
           name: first-setup
           path: |
               checksums.txt
-              vanilla-first-setup_*.deb
+              vanilla-first-setup.deb
 
       - uses: softprops/action-gh-release@v2
         if: github.ref == 'refs/heads/main'
@@ -51,4 +48,4 @@ jobs:
             name: "Continuous Build"
             files: |
               checksums.txt
-              vanilla-first-setup_*.deb
+              vanilla-first-setup.deb

.github/workflows/release.yml

@@ -20,29 +20,31 @@ jobs:
     steps:
         - uses: actions/checkout@v4
 
-        - name: Get the version
-          id: get_version
-          run: echo "{VERSION}={$(cat VERSION)}" >> $GITHUB_OUTPUT
+        - name: Set meson version by tag
+          id: set_version
+          run: |
+            sed -i 's/VTESTING/${{ github.ref_name }}/g' meson.build
   
         - name: Install build dependencies
           run: |
-            apt install -y debhelper python3 gettext build-essential desktop-file-utils ninja-build meson libadwaita-1-dev make libnm-dev libnma-dev libnma-gtk4-dev
+            apt-get update
+            apt-get build-dep -y .
   
         - name: Build .deb package
           run: |
               dpkg-buildpackage
-              mv ../vanilla-first-setup_*.deb .
+              mv ../vanilla-first-setup_*.deb vanilla-first-setup.deb
   
         - name: Calculate and Save Checksums
           run: |
-            sha256sum vanilla-first-setup_*.deb >> checksums.txt
+            sha256sum vanilla-first-setup.deb >> checksums.txt
   
         - uses: actions/upload-artifact@v4
           with:
             name: first-setup
             path: |
                 checksums.txt
-                vanilla-first-setup_*.deb
+                vanilla-first-setup.deb
 
   release:
     runs-on: ubuntu-latest
@@ -66,10 +68,10 @@ jobs:
       - name: Create Release
         env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: gh release create "${{ github.ref_name }}" --generate-notes *.deb checksums.txt
+        run: gh release create "${{ github.ref_name }}" --generate-notes vanilla-first-setup.deb checksums.txt
 
       - name: Attest Release Files
         id: attest
         uses: actions/attest-build-provenance@v1
         with:
-          subject-path: '*.deb, *.txt'
+          subject-path: 'vanilla-first-setup.deb, checksums.txt'

.gitignore

@@ -7,6 +7,7 @@ debian/vanilla-first-setup
 debian/.debhelper
 */__pycache__
 *.pyc
-/localbuild
+vanilla_first_setup/vanilla-first-setup.gresource
 .buildconfig
 install/
+localegen/

README.md

@@ -3,67 +3,128 @@
     <h1>Vanilla OS First Setup</h1>
     <p>This utility is meant to be used in <a href="https://github.com/vanilla-os">Vanilla OS</a>
     as a first-setup wizard. Its purpose is to help the user to configure the
-    system to their needs, e.g. by configuring snap, flatpak, flathub, etc.</p>
+    system to their needs, e.g. by configuring hostname, theme, flatpak apps, etc.</p>
     <hr />
-    <a href="https://hosted.weblate.org/engage/vanilla-os/">
+    <a href="https://hosted.weblate.org/projects/vanilla-os/first-setup/#information">
 <img src="https://hosted.weblate.org/widgets/vanilla-os/-/first-setup/svg-badge.svg" alt="Translation status" />
 </a>
     <br />
-    <img src="data/screenshot-1.png">
+    <img src="data/screenshots/welcome-page.png">
 </div>
 
+## Run without building for Testing
+
+> [!IMPORTANT]  
+> You need to install all build and run dependencies first
+
+```bash
+python3 test.py -d
+```
+
+The "-d" option is the dry-run mode, without it, first-setup will make changes to your system.
+
+Pass the "-c" flag to force the configure system mode.
+
+### Test translations:
+
+You can change the used language like this:
+```bash
+LANGUAGE=de python3 test.py -d
+```
+
 ## Build
 
-### Build Dependencies
+### Installing build dependencies
+```bash
+sudo apt-get update
+sudo apt-get build-dep .
+```
+
+If you want to install the build dependencies manually, have a look in:
+[debian/control](https://github.com/Vanilla-OS/first-setup/blob/main/debian/control)
+
+### Building
+
+> [!WARNING]  
+> dpkg-buildpackage places it's output files (Like the .deb file) into the parent folder.
+
 ```bash
-sudo apt install -y build-essential debhelper \
-                    python3 meson \
-                    libadwaita-1-dev gettext \
-                    desktop-file-utils \
-                    libjpeg-dev libnm-dev \
-                    libnma-dev libnma-gtk4-dev \
-                    ninja-build
+dpkg-buildpackage
 ```
 
-### Runtime Dependencies
+or manually with meson:
+
 ```bash
-sudo apt install -y python3 python3-gi \
-                    python3-tz libadwaita-1-0 \
-                    gir1.2-gtk-4.0 gir1.2-adw-1 \
-                    gir1.2-vte-3.91 libnm0 \
-                    libnma0 libnma-gtk4-0
+meson setup build
+meson compile -C build
 ```
 
-#### Optional Dependencies
+Here you can change the install folder (default is /usr/local), for example:
 ```bash
-sudo apt install python-requests # required for conn_check
-sudo apt install gir1.2-gweather-4.0 # required for timezones
-sudo apt install gir1.2-gnomedesktop-4.0 # required for languages, keyboard
-sudo apt install gir1.2-nma4-1.0 # required for network
-sudo apt install gir1.2-nm-1.0 # required for network
+meson setup --prefix="$(pwd)/install" build
 ```
 
-### Build
+## Install
+
+### Installing runtime dependencies
+These can be found here:
+[debian/control](https://github.com/Vanilla-OS/first-setup/blob/main/debian/control)
+
+> [!TIP]   
+> If you use apt-get to install the .deb file it will automatically install the dependencies.
+
+### Installing
 
 ```bash
-meson build
-ninja -C build
+sudo apt-get install ./vanilla-first-setup*.deb
 ```
 
-### Install
+or manually with meson:
 
 ```bash
-sudo ninja -C build install
+meson install -C build
 ```
 
 ## Run
 
+### Creating initial user
+
+A special user is needed to run the initial setup for hostname, user-creation, locale, etc.
+
+1. Create a user
+2. Create the group vanilla-first-setup (Changing the gid is recommended to avoid messing with user groups)
+3. Add the user to group vanilla-first-setup
+4. Create the file `/var/lib/AccountsService/users/your_user`
+```ini
+[User]
+Session=firstsetup
+```
+5. Create the file `/etc/gdm3/daemon.conf` (replace your_user)
+```ini
+[daemon]
+AutomaticLogin=your_user
+AutomaticLoginEnable=True
+```
+
+> [!WARNING]  
+> All users in this group will be deleted on the first reboot after a successful first setup.
+
+### Running
 ```bash
 vanilla-first-setup
 ```
 
-### Using custom recipes
+#### Flags:
+
+- --dry-run (-d): Don't make any changes to the system.
+- --force-configure-mode (-c): Force the configure system mode, independant of group.
+- --force-regular-mode (-r): Force the regular mode, independant of group.
+- --oem-mode (-o): Use the original equipment manufacturer mode with language, keyboard and timezone selection.
 
-Place a new recipe in `/etc/vanilla-first-setup/recipe.json` or launch the
-utility with the `VANILLA_CUSTOM_RECIPE` environment variable set to the path
-of the recipe.
+## Update translation file
+
+To update the .pot file with newly added translation strings, run:
+
+```bash
+meson compile -C build vanilla-first-setup-pot
+```

VERSION

@@ -1,9 +1,8 @@
 [Desktop Entry]
 Name=FirstSetup
 Comment=This session provides a First Setup interface
-Exec=env GNOME_SHELL_SESSION_MODE=firstsetup gnome-session --session=firstsetup
-TryExec=gnome-shell
-Icon=
+Exec=env GNOME_SHELL_SESSION_MODE=firstsetup /usr/bin/gnome-session
+TryExec=/usr/bin/gnome-session
 Type=Application
 DesktopNames=vanilla:GNOME
 X-GDM-SessionRegisters=true