Tracking for release 0.16.0

.github/workflows/build_and_test.yml

@@ -2,133 +2,133 @@ name: Build and Test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main", "dev" ]
+    branches: ["main", "dev"]
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
   linux:
-
     runs-on: ubuntu-latest
     timeout-minutes: 30
-
     steps:
-    - uses: actions/checkout@v4
-    - name: Clone spacebar server
-      run: |
-        git clone https://github.com/bitfl0wer/server.git
-    - uses: actions/setup-node@v4
-      with:
+      - uses: actions/checkout@v4
+      - name: Clone spacebar server
+        run: |
+          git clone https://github.com/bitfl0wer/server.git
+      - uses: actions/setup-node@v4
+        with:
           node-version: 18
-          cache: 'npm'
+          cache: "npm"
           cache-dependency-path: server/package-lock.json
-    - name: Prepare and start Spacebar server
-      run: |
-        npm install
-        npm run setup
-        npm run start &
-      working-directory: ./server
-    - uses: Swatinem/rust-cache@v2
-      with:
-        cache-all-crates: "true"
-        prefix-key: "linux"
-    - name: Build, Test and Publish Coverage
-      run: |
-        if [ -n "${{ secrets.COVERALLS_REPO_TOKEN }}" ]; then
-          curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
-          cargo binstall --no-confirm cargo-tarpaulin --force
-          cargo tarpaulin --all-features --avoid-cfg-tarpaulin --tests --verbose --skip-clean --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }} --timeout 120
-        else
-          echo "Code Coverage step is skipped on forks!"
-          cargo build --verbose --all-features
-          cargo test --verbose --all-features
-        fi
-  # wasm-safari:
-  #   runs-on: macos-latest
-  #   steps:
-  #   - uses: actions/checkout@v4
-  #   - name: Clone spacebar server
-  #     run: |
-  #       git clone https://github.com/bitfl0wer/server.git
-  #   - uses: actions/setup-node@v4
-  #     with:
-  #         node-version: 18
-  #         cache: 'npm'
-  #         cache-dependency-path: server/package-lock.json
-  #   - name: Prepare and start Spacebar server
-  #     run: |
-  #       npm install
-  #       npm run setup
-  #       npm run start &
-  #     working-directory: ./server
-  #   - uses: Swatinem/rust-cache@v2 
-  #     with:
-  #       cache-all-crates: "true"
-  #       prefix-key: "macos-safari"
-  #   - name: Run WASM tests with Safari, Firefox, Chrome
-  #     run: |
-  #       rustup target add wasm32-unknown-unknown
-  #       curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
-  #       cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
-  #       SAFARIDRIVER=$(which safaridriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt" --no-fail-fast
+      - name: Prepare and start Spacebar server
+        run: |
+          npm install
+          npm run setup
+          npm run start &
+        working-directory: ./server
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          prefix-key: "linux"
+      - uses: taiki-e/install-action@nextest
+      - name: Build, Test with nextest, Publish Coverage
+        run: |
+          if [ -n "${{ secrets.COVERALLS_REPO_TOKEN }}" ]; then
+            if [ "${{github.event.pull_request.head.ref}}" = "main" ]; then
+              curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
+              cargo binstall --no-confirm cargo-tarpaulin --force
+              cargo tarpaulin --all-features --avoid-cfg-tarpaulin --tests --verbose --skip-clean --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }} --timeout 120
+            else
+              echo "Code Coverage step is skipped on non-main PRs and PRs from forks."
+              cargo nextest run --verbose --all-features
+            fi
+          else
+            echo "Code Coverage step is skipped on non-main PRs and PRs from forks."
+            cargo nextest run --verbose --all-features
+          fi
+  linux-non-default-features:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check common non-default feature configurations
+        run: |
+          echo "No features:"
+          cargo check --features="" --no-default-features
+          echo "Only client:"
+          cargo check --features="client" --no-default-features
+          echo "Only backend:"
+          cargo check --features="backend" --no-default-features
+          echo "Only voice:"
+          cargo check --features="voice" --no-default-features
+          echo "Only voice gateway:"
+          cargo check --features="voice_gateway" --no-default-features
+          echo "Backend + client:"
+          cargo check --features="backend, client" --no-default-features
+          echo "Backend + voice:"
+          cargo check --features="backend, voice" --no-default-features
+          echo "Backend + voice gateway:"
+          cargo check --features="backend, voice_gateway" --no-default-features
+          echo "Client + voice gateway:"
+          cargo check --features="client, voice_gateway" --no-default-features
   wasm-gecko:
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-    - uses: actions/checkout@v4
-    - name: Clone spacebar server
-      run: |
-        git clone https://github.com/bitfl0wer/server.git
-    - uses: actions/setup-node@v4
-      with:
+      - uses: actions/checkout@v4
+      - name: Clone spacebar server
+        run: |
+          git clone https://github.com/bitfl0wer/server.git
+      - uses: actions/setup-node@v4
+        with:
           node-version: 18
-          cache: 'npm'
+          cache: "npm"
           cache-dependency-path: server/package-lock.json
-    - name: Prepare and start Spacebar server
-      run: |
-        npm install
-        npm run setup
-        npm run start &
-      working-directory: ./server
-    - uses: Swatinem/rust-cache@v2 
-      with:
-        cache-all-crates: "true"
-        prefix-key: "macos"
-    - name: Run WASM tests with Safari, Firefox, Chrome
-      run: |
-        rustup target add wasm32-unknown-unknown
-        curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
-        cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
-        GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
+      - name: Prepare and start Spacebar server
+        run: |
+          npm install
+          npm run setup
+          npm run start &
+        working-directory: ./server
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          prefix-key: "macos"
+      - name: Run WASM tests with Safari, Firefox, Chrome
+        run: |
+          rustup target add wasm32-unknown-unknown
+          curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
+          cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.93" --force
+          GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
   wasm-chrome:
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
     timeout-minutes: 30
     steps:
-    - uses: actions/checkout@v4
-    - name: Clone spacebar server
-      run: |
-        git clone https://github.com/bitfl0wer/server.git
-    - uses: actions/setup-node@v4
-      with:
+      - uses: actions/checkout@v4
+      - name: Clone spacebar server
+        run: |
+          git clone https://github.com/bitfl0wer/server.git
+      - uses: actions/setup-node@v4
+        with:
           node-version: 18
-          cache: 'npm'
+          cache: "npm"
           cache-dependency-path: server/package-lock.json
-    - name: Prepare and start Spacebar server
-      run: |
-        npm install
-        npm run setup
-        npm run start &
-      working-directory: ./server
-    - uses: Swatinem/rust-cache@v2 
-      with:
-        cache-all-crates: "true"
-        prefix-key: "macos"
-    - name: Run WASM tests with Safari, Firefox, Chrome
-      run: |
-        rustup target add wasm32-unknown-unknown
-        curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
-        cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
-        CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
+      - name: Prepare and start Spacebar server
+        run: |
+          npm install
+          npm run setup
+          npm run start &
+        working-directory: ./server
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          prefix-key: "macos"
+      - name: Run WASM tests with Safari, Firefox, Chrome
+        run: |
+          rustup target add wasm32-unknown-unknown
+          curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
+          cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.93" --force
+          CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"

.github/workflows/cargo-doc.yml

@@ -0,0 +1,35 @@
+name: cargo doc lints
+
+on:
+  push:
+    branches: [ "main", "preserve/*" ]
+  pull_request:
+    branches: [ "main", "dev" ]
+
+jobs:
+  cargo-doc-lints:
+    name: Run cargo doc for doc lints
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install aditional components for sarif
+        run: cargo install clippy-sarif sarif-fmt
+
+      - name: Run cargo doc
+        run: cargo doc --no-deps --all-features --locked --message-format=json | clippy-sarif | sed 's/rust-lang.github.io\/rust-clippy/doc.rust-lang.org\/rustdoc\/lints.html/g' | sed 's/clippy/rustdoc/g' | tee cargo-doc-results.sarif | sarif-fmt
+        continue-on-error: true
+
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: cargo-doc-results.sarif
+          wait-for-processing: true

CONTRIBUTING.md

@@ -3,8 +3,10 @@
 
 **Please refer to the [contribution guidelines](https://github.com/polyphony-chat/.github/blob/main/CONTRIBUTION_GUIDELINES.md) and [our Code of Conduct](https://github.com/polyphony-chat/.github/blob/main/CODE_OF_CONDUCT.md) before making a contribution.**
 
+Contributions should always fork from and merge back into the `dev` branch.
+
 Chorus is currently missing voice support and a lot of API endpoints, many of which should be trivial to implement,
 ever since [we streamlined the process of doing so](https://github.com/polyphony-chat/chorus/discussions/401).
 
 If you'd like to contribute new functionality, check out [The 'Meta'-issues.](https://github.com/polyphony-chat/chorus/issues?q=is%3Aissue+label%3A%22Type%3A+Meta%22+) They contain a comprehensive list of all features which are yet missing for full Discord.com compatibility.
-Please feel free to open an Issue with the idea you have, or a Pull Request. 
+Please feel free to open an Issue with the idea you have, or a Pull Request.