feat: pack .zip along with .wsl

- functionize
- use static download link for wsldl, jq no longer needed
- update docs

Author: Vinfall

.github/workflows/build.yml

@@ -25,16 +25,16 @@ jobs:
       - name: build
         run: |
           mkdir -p release
-          sudo apt install -y curl jq pigz tar unzip zip
+          sudo apt install -y curl pigz tar unzip zip
           sudo ./build.sh
-          mv Devuan.zip* release/
+          mv Devuan.* release/
       - name: upload as artifact
         uses: actions/upload-artifact@v5
         with:
           retention-days: 90
           path: release/*
       - name: upload as release
-        run: gh release upload "${TAG}" --clobber release/Devuan.zip*
+        run: gh release upload "${TAG}" --clobber release/Devuan.*
         env:
           GH_TOKEN: ${{ github.token }}
           TAG: action-build

README.md

@@ -12,20 +12,46 @@ THIS REPO IS NOT AFFILIATE TO THE OFFICIAL "DEVUAN LINUX" DISTRIBUTION IN ANY WA
 
 ## Install
 
-1. Download installer zip from [releases](https://github.com/Vinfall/DevuanWSL/releases/tag/action-build)
-2. (Optinally) verify hash to avoid file corruption
+Traditional `.zip` with rootfs+wsldl and the new `.wsl` format are both provided.
+
+`.zip` is recommended and [#Usage](#usage)/[#Backup](#backup) only applies to this.
+
+You can use `.wsl` if:
+
+- you don't mind installing WSL to system drive
+- just want one-off shot on DevuanWSL
+
+### `.zip`
+
+1. Download `Devuan.zip` and `Devuan.zip.sha512` from [releases](https://github.com/Vinfall/DevuanWSL/releases/tag/action-build)
+2. Verify hash to avoid file corruption
 3. Extract all files in zip file to same directory (e.g. `D:\WSL\Devuan`)
-4. Run `Devuan.exe` to extract rootfs and Register to WSL
+4. Run `Devuan.exe` to extract rootfs and register to WSL
 
-`Devuan.exe` is used as WSL distro label.
+`Devuan` in `Devuan.exe` is used as WSL distro label.
 It's possible to have multiple installs by renaming it to something like `Dedede.exe`.
 
-## Uninstall
+To uninstall:
 
 ```powershell
+# path to DevuanWSL directory
+# cd D:\WSL\Devuan
 .\Devuan.exe clean
 ```
 
+### `.wsl`
+
+1. Download `Devuan.wsl` and `Devuan.wsl.sha512` from [releases](https://github.com/Vinfall/DevuanWSL/releases/tag/action-build)
+2. Verify hash to avoid file corruption
+3. Click `Devuan.wsl` to install
+4. Finish the prompted oobe and create a new user
+
+To uninstall:
+
+```powershell
+wsl --unregister Devuan
+```
+
 ## Usage
 
 <details><summary>Click to expand</summary>
@@ -75,14 +101,14 @@ Usage:
 
 DevuanWSL can be built on GNU/Linux or WSL.
 
-`curl`, `jq`, `unzip` and `zip` is required for build.
+`curl`, `unzip` and `zip` is required for build.
 `pigz` is recommended over `gzip` and used by default.
 
 ```bash
 # Install build tools
-sudo apt install -y curl jq pigz tar unzip zip
+sudo apt install -y curl pigz tar unzip zip
 # Make release
-# Use `sudo` here as partitions mounted via WSL are owned by current user
+# use `sudo` here as partitions mounted via WSL are owned by current user
 # (e.g. UID 1000) but rootfs requires root aka. UID 0
 sudo ./build.sh
 ```

build.sh

@@ -1,35 +1,49 @@
 #!/bin/bash
 set -euo pipefail
+IFS=$'\n\t'
 # shellcheck disable=SC2035
 
-# download
-# echo "Downloading wsldl..."
-# curl --silent --location "https://github.com/yuk7/wsldl/releases/download/$(curl https://api.github.com/repos/yuk7/wsldl/releases/latest -s | jq .name -r)/icons.zip"
-# echo "Downloading tarball..."
-# curl --silent --localtion "https://jenkins.linuxcontainers.org/view/Images/job/image-devuan/architecture=amd64,release=excalibur,variant=default/lastSuccessfulBuild/artifact/rootfs.tar.xz"
-
-# build
-echo "Extracting..."
-unzip -u icons.zip Devuan.exe
-
-mkdir -p ziproot/usr/lib/wsl # mkdir ziproot
-cp rootfs.tar.xz ziproot/
-
-tar -C ziproot -xf rootfs.tar.xz
-install -pm644 fs/etc/wsl-distribution.conf ziproot/etc/wsl-distribution.conf
-install -pm755 fs/usr/lib/wsl/oobe ziproot/usr/lib/wsl/oobe
-install -pm644 fs/usr/lib/wsl/devuan.ico ziproot/usr/lib/wsl/devuan.ico
-install -pm644 fs/usr/lib/wsl/terminal-profile.json ziproot/usr/lib/wsl/terminal-profile.json
-tar -C ziproot --numeric-owner --absolute-names --create . | pigz > ziproot/Devuan.wsl
-# tar -C ziproot --numeric-owner --absolute-names --create . | gzip --best > ziproot/Devuan.wsl
-shopt -s extglob
-rm -r -- ziproot/!(Devuan.wsl)
-
-cp Devuan.exe ziproot/Devuan.exe
-
-zip -j Devuan.zip ziproot/*
-sha512sum Devuan.zip > Devuan.zip.sha512
-
-# clean
-rm -rf ziproot Devuan.exe
-# rm -r icons.zip rootfs.tar.xz
+download(){
+    echo "Downloading wsldl..."
+    curl -Lo icons.zip "https://github.com/yuk7/wsldl/releases/latest/download/icons.zip"
+    echo "Downloading tarball..."
+    curl -Lo rootfs.tar.xz "https://jenkins.linuxcontainers.org/view/Images/job/image-devuan/architecture=amd64,release=excalibur,variant=default/lastSuccessfulBuild/artifact/rootfs.tar.xz"
+}
+
+build(){
+    echo "Extracting..."
+    unzip -u icons.zip Devuan.exe
+
+    echo "Packing wsl..."
+    mkdir ziproot
+    mkdir -p ziproot/usr/lib/wsl
+    cp rootfs.tar.xz ziproot/rootfs.tar.xz
+
+    tar -C ziproot -xf rootfs.tar.xz
+    install -pm644 fs/etc/wsl-distribution.conf ziproot/etc/wsl-distribution.conf
+    install -pm755 fs/usr/lib/wsl/oobe ziproot/usr/lib/wsl/oobe
+    install -pm644 fs/usr/lib/wsl/devuan.ico ziproot/usr/lib/wsl/devuan.ico
+    install -pm644 fs/usr/lib/wsl/terminal-profile.json ziproot/usr/lib/wsl/terminal-profile.json
+    tar -C ziproot --numeric-owner --absolute-names --create . | pigz > Devuan.wsl
+    # tar -C ziproot --numeric-owner --absolute-names --create . | gzip --best Devuan.wsl
+
+    rm -rf ziproot
+    sha512sum Devuan.wsl > Devuan.wsl.sha512
+
+    echo "Packing zip..."
+    cp rootfs.tar.xz ziproot/rootfs.tar.xz
+    cp Devuan.exe ziproot/Devuan.exe
+    zip -j Devuan.zip ziproot/*
+    # sudo chown "$(whoami):$(whoami)" Devuan.zip
+    sha512sum Devuan.zip > Devuan.zip.sha512
+}
+
+clean(){
+    echo "Cleaning..."
+    rm -rf ziproot Devuan.exe
+    # rm -r icons.zip rootfs.tar.xz
+}
+
+download
+build
+clean