Update README and LICENSE

elixir-webrtc · Jul 28, 2024 · f2ce74e · f2ce74e
1 parent b808ed4
commit f2ce74e
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 13 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,19 +16,26 @@ jobs:
         with:
           otp-version: ${{matrix.otp}}
           elixir-version: ${{matrix.elixir}}
+      - name: Cache dialyzer artifacts
+        uses: actions/cache@v4
+        with:
+          path: _dialyzer
+          key: ${{ runner.os }}-dialyzer-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-dialyzer-
       - run: mix deps.get
       - run: mix credo
       - run: mix format --check-formatted
+      - run: mix dialyzer
       - run: mix docs 2>&1 | (! grep -q "warning:")
 
   test-linux:
+    runs-on: ubuntu-22.04
+    name: test-linux-x86-64 / ubuntu-22.04 / OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
     strategy:
       matrix:
-        os: ['ubuntu-24.04', 'ubuntu-22.04']
         otp: ['25']
         elixir: ['1.14']
-    runs-on: ${{ matrix.os }}
-    name: test-linux-x86-64 / ${{ matrix.os }} / OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
     env:
       MIX_ENV: test
     steps:
@@ -41,6 +48,29 @@ jobs:
       - run: mix deps.get
       - run: mix test
 
+  test-linux-coverage:
+    runs-on: ubuntu-24.04
+    name: test-linux-x86-64 / ubuntu-24.04 / OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
+    strategy:
+      matrix:
+        otp: ['25']
+        elixir: ['1.14']
+    env:
+      MIX_ENV: test
+    steps:
+      - uses: actions/checkout@v2
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{matrix.otp}}
+          elixir-version: ${{matrix.elixir}}
+      - run: sudo apt install libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libavdevice-dev
+      - run: mix deps.get
+      - run: mix coveralls.json
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
   test-macos:
     runs-on: macos-13
     name: test-macos-x86-64 / macos-13 / OTP latest / Elixir latest

diff --git a/README.md b/README.md
@@ -1,6 +1,9 @@
 # Xav
 
-[![Documentation](https://img.shields.io/badge/-Documentation-blueviolet)](https://hexdocs.pm/xav/)
+[![Hex.pm](https://img.shields.io/hexpm/v/xav.svg)](https://hex.pm/packages/xav)
+[![API Docs](https://img.shields.io/badge/api-docs-yellow.svg?style=flat)](https://hexdocs.pm/xav)
+[![CI](https://img.shields.io/github/actions/workflow/status/elixir-webrtc/xav/ci.yml?logo=github&label=CI)](https://github.com/elixir-webrtc/xav/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/elixir-webrtc/xav/graph/badge.svg?token=2AG2acRhOf)](https://codecov.io/gh/elixir-webrtc/xav)
 
 Elixir wrapper over FFmpeg for reading audio and video files.
 
@@ -64,10 +67,4 @@ frames =
 batch = Nx.Batch.concatenate(frames)
 batch = Nx.Defn.jit_apply(&Function.identity/1, [batch])
 Nx.Serving.run(serving, batch) 
-```
-
-## LICENSE
-
-Copyright 2023, Michał Śledź
-
-Licensed under the [MIT](./LICENSE)
+```
diff --git a/codecov.yml b/codecov.yml
diff --git a/mix.exs b/mix.exs
@@ -1,16 +1,39 @@
 defmodule Xav.MixProject do
   use Mix.Project
 
+  @version "0.4.0"
+  @source_url "https://github.com/elixir-webrtc/xav"
+
   def project do
     [
       app: :xav,
       version: "0.4.0",
       elixir: "~> 1.14",
       start_permanent: Mix.env() == :prod,
-      description: "Elixir media library built on top of FFmpeg",
+      description: "Elixir audio/video library built on top of FFmpeg",
       package: package(),
       compilers: [:elixir_make] ++ Mix.compilers(),
-      deps: deps()
+      deps: deps(),
+
+      # docs
+      docs: docs(),
+      source_url: @source_url,
+
+      # dialyzer
+      dialyzer: [
+        plt_local_path: "_dialyzer",
+        plt_core_path: "_dialyzer"
+      ],
+
+      # code coverage
+      test_coverage: [tool: ExCoveralls],
+      preferred_cli_env: [
+        coveralls: :test,
+        "coveralls.detail": :test,
+        "coveralls.post": :test,
+        "coveralls.html": :test,
+        "coveralls.json": :test
+      ]
     ]
   end
 
@@ -32,9 +55,21 @@ defmodule Xav.MixProject do
     [
       {:nx, "~> 0.7.0"},
       {:elixir_make, "~> 0.7", runtime: false},
+
+      # dev/test
+      {:excoveralls, "~> 0.18.0", only: [:dev, :test], runtime: false},
       {:ex_doc, ">= 0.0.0", runtime: false, only: :dev},
       {:credo, ">= 0.0.0", runtime: false, only: :dev},
       {:dialyxir, ">= 0.0.0", runtime: false, only: :dev}
     ]
   end
+
+  defp docs do
+    [
+      main: "readme",
+      extras: ["README.md", "INSTALL.md"],
+      source_ref: "v#{@version}",
+      formatters: ["html"]
+    ]
+  end
 end
diff --git a/mix.lock b/mix.lock
@@ -7,6 +7,7 @@
   "elixir_make": {:hex, :elixir_make, "0.7.8", "505026f266552ee5aabca0b9f9c229cbb496c689537c9f922f3eb5431157efc7", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:certifi, "~> 2.0", [hex: :certifi, repo: "hexpm", optional: true]}], "hexpm", "7a71945b913d37ea89b06966e1342c85cfe549b15e6d6d081e8081c493062c07"},
   "erlex": {:hex, :erlex, "0.2.6", "c7987d15e899c7a2f34f5420d2a2ea0d659682c06ac607572df55a43753aa12e", [:mix], [], "hexpm", "2ed2e25711feb44d52b17d2780eabf998452f6efda104877a3881c2f8c0c0c75"},
   "ex_doc": {:hex, :ex_doc, "0.31.1", "8a2355ac42b1cc7b2379da9e40243f2670143721dd50748bf6c3b1184dae2089", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.1", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "3178c3a407c557d8343479e1ff117a96fd31bafe52a039079593fb0524ef61b0"},
+  "excoveralls": {:hex, :excoveralls, "0.18.2", "86efd87a0676a3198ff50b8c77620ea2f445e7d414afa9ec6c4ba84c9f8bdcc2", [:mix], [{:castore, "~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "230262c418f0de64077626a498bd4fdf1126d5c2559bb0e6b43deac3005225a4"},
   "file_system": {:hex, :file_system, "1.0.0", "b689cc7dcee665f774de94b5a832e578bd7963c8e637ef940cd44327db7de2cd", [:mix], [], "hexpm", "6752092d66aec5a10e662aefeed8ddb9531d79db0bc145bb8c40325ca1d8536d"},
   "jason": {:hex, :jason, "1.4.1", "af1504e35f629ddcdd6addb3513c3853991f694921b1b9368b0bd32beb9f1b63", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "fbb01ecdfd565b56261302f7e1fcc27c4fb8f32d56eab74db621fc154604a7a1"},
   "makeup": {:hex, :makeup, "1.1.1", "fa0bc768698053b2b3869fa8a62616501ff9d11a562f3ce39580d60860c3a55e", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "5dc62fbdd0de44de194898b6710692490be74baa02d9d108bc29f007783b0b48"},