config: release-please (#15)

Author: zoedsoupe

.github/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0"
+}

.github/release-please-config.json

@@ -0,0 +1,75 @@
+{
+  "bootstrap-sha": "f471986",
+  "pull-request-header": ":rocket: Want to release this?",
+  "pull-request-title-pattern": "chore: release ${version}",
+  "changelog-sections": [
+    {
+      "type": "feat",
+      "section": "Features"
+    },
+    {
+      "type": "feature",
+      "section": "Features"
+    },
+    {
+      "type": "fix",
+      "section": "Bug Fixes"
+    },
+    {
+      "type": "perf",
+      "section": "Performance Improvements"
+    },
+    {
+      "type": "revert",
+      "section": "Reverts"
+    },
+    {
+      "type": "docs",
+      "section": "Documentation",
+      "hidden": false
+    },
+    {
+      "type": "style",
+      "section": "Styles",
+      "hidden": false
+    },
+    {
+      "type": "chore",
+      "section": "Miscellaneous Chores",
+      "hidden": false
+    },
+    {
+      "type": "refactor",
+      "section": "Code Refactoring",
+      "hidden": false
+    },
+    {
+      "type": "test",
+      "section": "Tests",
+      "hidden": false
+    },
+    {
+      "type": "build",
+      "section": "Build System",
+      "hidden": false
+    },
+    {
+      "type": "ci",
+      "section": "Continuous Integration",
+      "hidden": false
+    }
+  ],
+  "extra-files": [
+    {
+      "type": "generic",
+      "path": "README.md",
+      "glob": false
+    }
+  ],
+  "packages": {
+    ".": {
+      "release-type": "elixir"
+    }
+  },
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
+}

.github/workflows/ci.yml

@@ -17,8 +17,17 @@ jobs:
 
     strategy:
       matrix:
-        elixir: [1.18.1]
-        otp: [27.0]
+        include:
+          - elixir: 1.18
+            otp: 27
+          - elixir: 1.18
+            otp: 26
+          - elixir: 1.17
+            otp: 27
+          - elixir: 1.17
+            otp: 26
+          - elixir: 1.17
+            otp: 25
 
     steps:
       - name: Checkout code
@@ -64,16 +73,25 @@ jobs:
       - name: Run Credo
         run: mix credo --strict
 
-  static-analisys:
+  static-analysis:
     runs-on: ubuntu-latest
 
     env:
       MIX_ENV: test
 
     strategy:
       matrix:
-        elixir: [1.18.1]
-        otp: [27.0]
+        include:
+          - elixir: 1.18
+            otp: 27
+          - elixir: 1.18
+            otp: 26
+          - elixir: 1.17
+            otp: 27
+          - elixir: 1.17
+            otp: 26
+          - elixir: 1.17
+            otp: 25
 
     steps:
       - name: Checkout code
@@ -110,29 +128,25 @@ jobs:
         if: steps.build-cache.outputs.cache-hit != 'true'
         run: mix deps.compile --warnings-as-errors
 
-      # Don't cache PLTs based on mix.lock hash, as Dialyzer can incrementally update even old ones
-      # Cache key based on Elixir & Erlang version (also useful when running in matrix)
-      - name: Restore PLT cache
-        uses: actions/cache/restore@v3
+      # Ensure PLTs directory exists
+      - name: Create PLTs directory
+        run: mkdir -p priv/plts
+
+      # Cache PLTs based on Elixir & Erlang version + mix.lock hash
+      - name: Restore/Save PLT cache
+        uses: actions/cache@v4
         id: plt_cache
         with:
-          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt
-          restore-keys: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt
           path: priv/plts
+          key: plt-${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('mix.lock') }}
+          restore-keys: |
+            plt-${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-
 
       # Create PLTs if no cache was found
       - name: Create PLTs
         if: steps.plt_cache.outputs.cache-hit != 'true'
         run: mix dialyzer --plt
 
-      - name: Save PLT cache
-        uses: actions/cache/save@v3
-        if: steps.plt_cache.outputs.cache-hit != 'true'
-        id: plt_cache_save
-        with:
-          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-plt
-          path: priv/plts
-
       - name: Run dialyzer
         run: mix dialyzer --format github
 
@@ -144,8 +158,17 @@ jobs:
 
     strategy:
       matrix:
-        elixir: [1.18.1]
-        otp: [27.0]
+        include:
+          - elixir: 1.18
+            otp: 27
+          - elixir: 1.18
+            otp: 26
+          - elixir: 1.17
+            otp: 27
+          - elixir: 1.17
+            otp: 26
+          - elixir: 1.17
+            otp: 25
 
     steps:
       - name: Checkout code
@@ -186,4 +209,4 @@ jobs:
         run: mix clean
 
       - name: Run tests
-        run: mix test
+        run: mix test --warnings-as-errors

.github/workflows/release-please.yml

@@ -0,0 +1,25 @@
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: Release Please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          config-file: .github/release-please-config.json
+          manifest-file: .github/.release-please-manifest.json

README.md

@@ -24,7 +24,7 @@ Add `supabase_realtime` to your list of dependencies in `mix.exs`:
 def deps do
   [
     {:supabase_potion, "~> 0.6"},
-    {:supabase_realtime, "~> 0.1"}
+    {:supabase_realtime, "~> 0.1.0"} # x-release-version
   ]
 end
 ```

flake.lock

@@ -1,31 +1,30 @@
 {
-  inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-25.05-small";
+    elixir-overlay.url = "github:zoedsoupe/elixir-overlay";
+  };
 
-  outputs = {nixpkgs, ...}: let
+  outputs = {
+    nixpkgs,
+    elixir-overlay,
+    ...
+  }: let
     inherit (nixpkgs.lib) genAttrs;
     inherit (nixpkgs.lib.systems) flakeExposed;
     forAllSystems = f:
-      genAttrs flakeExposed (system: f (import nixpkgs {inherit system;}));
+      genAttrs flakeExposed (system:
+        f (import nixpkgs {
+          inherit system;
+          overlays = [elixir-overlay.overlays.default];
+        }));
   in {
     devShells = forAllSystems (pkgs: let
       inherit (pkgs) mkShell;
       inherit (pkgs.beam.interpreters) erlang_27;
-      inherit (pkgs.beam) packagesWith;
-      beam = packagesWith erlang_27;
-      elixir_1_18 = beam.elixir.override {
-        version = "1.18.2";
-
-        src = pkgs.fetchFromGitHub {
-          owner = "elixir-lang";
-          repo = "elixir";
-          rev = "v1.18.2";
-          sha256 = "sha256-8FhUKAaEjBBcF0etVPdkxMfrnR5niU40U8cxDRJdEok=";
-        };
-      };
     in {
       default = mkShell {
         name = "realtime-ex";
-        packages = [elixir_1_18 erlang_27];
+        packages = with pkgs; [elixir-bin."1.18.4" erlang_27 postgresql];
       };
     });
   };

flake.nix

@@ -8,7 +8,7 @@ defmodule Supabase.Realtime.MixProject do
     [
       app: :supabase_realtime,
       version: @version,
-      elixir: "~> 1.18",
+      elixir: "~> 1.17",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       docs: docs(),