Merge pull request #54 from HEnquist/updateci

Updateci

Author: HEnquist

.github/workflows/ci_test.yml

@@ -3,8 +3,8 @@ on: [push, pull_request]
 name: CI test and lint
 
 jobs:
-  check:
-    name: Check
+  check_lint_linux:
+    name: Check test and lint Linux
     runs-on: ubuntu-latest
     container: ubuntu:19.10
     steps:
@@ -23,6 +23,7 @@ jobs:
           profile: minimal
           toolchain: stable
           override: true
+          components: rustfmt, clippy
 
       - name: Install Alsa devel
         run: apt-get install libasound2-dev -y
@@ -41,8 +42,27 @@ jobs:
           command: check
           args: --no-default-features
 
-  check_cross:
-    name: CheckCross
+      - name: Run cargo test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+
+      - name: Run cargo fmt
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check
+
+      - name: Run cargo clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: -- -D warnings
+
+
+
+  check_arm:
+    name: Check and test Linux arm
     runs-on: ubuntu-latest
     steps:
       - name: Checkout sources
@@ -74,17 +94,10 @@ jobs:
           args: --target armv7-unknown-linux-gnueabihf --no-default-features --features alsa-backend --features socketserver
 
 
-  test:
-    name: Test Suite
-    runs-on: ubuntu-latest
-    container: ubuntu:19.10
+  check_lint_windows:
+    name: Check and test Windows
+    runs-on: windows-latest
     steps:
-      - name: Update package list
-        run: apt-get update
-          
-      - name: Install utils
-        run: apt-get install curl wget -y
-
       - name: Checkout sources
         uses: actions/checkout@v2
 
@@ -95,28 +108,22 @@ jobs:
           toolchain: stable
           override: true
 
-      - name: Install Alsa devel
-        run: apt-get install libasound2-dev -y
-
-      - name: Install PulseAudio
-        run: apt-get install libpulse0 libpulse-dev -y
+      - name: Run cargo check
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --no-default-features --features cpal-backend
 
       - name: Run cargo test
         uses: actions-rs/cargo@v1
         with:
           command: test
+          args: --no-default-features --features cpal-backend
 
-  lints:
-    name: Lints
-    runs-on: ubuntu-latest
-    container: ubuntu:19.10
+  check_lint_macos:
+    name: Check and test macOS
+    runs-on: macos-latest
     steps:
-      - name: Update package list
-        run: apt-get update
-          
-      - name: Install utils
-        run: apt-get install curl wget -y
-
       - name: Checkout sources
         uses: actions/checkout@v2
 
@@ -126,22 +133,19 @@ jobs:
           profile: minimal
           toolchain: stable
           override: true
-          components: rustfmt, clippy
-
-      - name: Install Alsa devel
-        run: apt-get install libasound2-dev -y
-
-      - name: Install PulseAudio
-        run: apt-get install libpulse0 libpulse-dev -y
 
-      - name: Run cargo fmt
+      - name: Run cargo check
         uses: actions-rs/cargo@v1
         with:
-          command: fmt
-          args: --all -- --check
+          command: check
+          args: --no-default-features --features cpal-backend
 
-      - name: Run cargo clippy
+      - name: Run cargo test
         uses: actions-rs/cargo@v1
         with:
-          command: clippy
-          args: -- -D warnings
+          command: test
+          args: --no-default-features --features cpal-backend
+
+
+
+

.github/workflows/publish.yml

@@ -39,12 +39,15 @@ jobs:
           command: build
           args: --release
 
+      - name: Compress
+        run: tar -zcvf camilladsp.tar.gz -C target/release camilladsp
+
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v1-release
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: target/release/camilladsp
-          asset_name: camilladsp-linux-amd64
+          file: camilladsp.tar.gz
+          asset_name: camilladsp-linux-amd64.tar.gz
           tag: ${{ github.ref }}
 
   arm:
@@ -74,12 +77,15 @@ jobs:
         env:
           RUSTFLAGS: "-C target-feature=+neon"
 
+      - name: Compress
+        run: tar -zcvf camilladsp.tar.gz -C target/armv7-unknown-linux-gnueabihf/release camilladsp
+
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v1-release
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: target/armv7-unknown-linux-gnueabihf/release/camilladsp
-          asset_name: camilladsp-linux-armv7
+          file: camilladsp.tar.gz
+          asset_name: camilladsp-linux-armv7.tar.gz
           tag: ${{ github.ref }}
 
   windows:
@@ -102,12 +108,15 @@ jobs:
           command: build
           args: --release --no-default-features --features cpal-backend --features socketserver
 
+      - name: Compress
+        run: powershell Compress-Archive target/release/camilladsp.exe camilladsp.zip
+
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v1-release
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: target/release/camilladsp.exe
-          asset_name: camilladsp-windows-amd64.exe
+          file: camilladsp.zip
+          asset_name: camilladsp-windows-amd64.zip
           tag: ${{ github.ref }}
 
   macos:
@@ -130,10 +139,13 @@ jobs:
           command: build
           args: --release --no-default-features --features cpal-backend --features socketserver
 
+      - name: Compress
+        run: zip -j camilladsp.zip target/release/camilladsp
+
       - name: Upload binaries to release
         uses: svenstaro/upload-release-action@v1-release
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: target/release/camilladsp
-          asset_name: camilladsp-macos-amd64
+          file: camilladsp.zip
+          asset_name: camilladsp-macos-amd64.zip
           tag: ${{ github.ref }}

README.md

@@ -101,21 +101,24 @@ These are the key dependencies for CamillDSP.
 
 # Installing
 
-The easiest way to install CamillaDSP is to download a pre-built binary. This is a single executable file that is ready to run. Binaries for each release are available for the most common systems. See the ["Releases"](https://github.com/HEnquist/camilladsp/releases) page. To see the files click "Assets".
+The easiest way to install CamillaDSP is to download a pre-built binary. Binaries for each release are available for the most common systems. See the ["Releases"](https://github.com/HEnquist/camilladsp/releases) page. To see the files click "Assets".
 
-The following configurations are provided:
+These are compressed files containing a single executable file that is ready to run. 
 
-- `camilladsp-linux-amd64`: Linux on 64-bit Intel or AMD cpu. Supports Alsa and Pulseaudio.
-- `camilladsp-linux-armv7`: Linux on armv7 with neon, intended for Raspberry Pi but should also work on others. Supports Alsa.
-- `camilladsp-macos-amd64`: macOS on 64-bit Intel cpu. Supports CoreAudio.
-- `camilladsp-windows-amd64.exe`: Windows on 64-bit Intel or AMD cpu. Supports Wasapi.
+The following configurations are provided:
+| Filename | Description | Backends |
+|----------|-------------|----------|
+| `camilladsp-linux-amd64.tar.gz` | Linux on 64-bit Intel or AMD CPU | Alsa, Pulseaudio |
+| `camilladsp-linux-armv7.tar.gz` | Linux on Armv7 with Neon, intended for Raspberry Pi 2 and up but should also work on others | Alsa |
+| `camilladsp-macos-amd64.zip` | macOS on 64-bit Intel CPU | CoreAudio |
+| `camilladsp-windows-amd64.zip` | Windows on 64-bit Intel or AMD CPU | Wasapi |
 
 All builds include the Websocket server.
 
-On Linux and macOS the file needs to be marked as executable after downloading. This can be done in the terminal with the `chmod` command, for example: 
+The `.tar.gz`-files can be uncompressed with the `tar` comand: 
 
 ```sh 
-chmod a+x camilladsp-linux-amd64
+tar -xvf camilladsp-linux-amd64.tar.gz
 ```