Version 1.0.0

Author: ziopio

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-and-docs:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        otp: ['28', '27']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Erlang/OTP
+        uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp }}
+          rebar3-version: '3'
+
+      - name: Compile
+        run: rebar3 compile
+
+      - name: Run ex_doc
+        run: rebar3 ex_doc
+
+      - name: Run dialyzer
+        run: rebar3 dialyzer

.gitignore

@@ -1,4 +1,5 @@
 .rebar3
+doc
 _build
 _checkouts
 _vendor

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [1.0.0] - 2025-10-21
+
 ### Added
 
 - Initial implementation of keychain API for managing TLS certificates and keys
@@ -24,5 +26,5 @@ and this project adheres to
   - `tls_options/1` - Get TLS options for a specific domain
   - `read_cert/2` - Read primary client certificate in DER format
 
-
-[Unreleased]: https://github.com/grisp/grisp_keychain/compare/404eb05fcd0654c496caaca6f961142305792d99...HEAD
+[Unreleased]: https://github.com/grisp/grisp_keychain/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/grisp/grisp_keychain/releases/tag/1.0.0

rebar.config

@@ -15,7 +15,13 @@
         {"LICENSE.md", #{title => "License"}}
     ]},
     {main, "README.md"},
-    {source_url, <<"https://github.com/grisp/grisp_keychain">>}
+    {homepage_url, "https://github.com/grisp/grisp_keychain"},
+    {source_url, <<"https://github.com/grisp/grisp_keychain">>},
+    {api_reference, true}
 ]}.
 
 {hex, [{doc, ex_doc}]}.
+
+{dialyzer, [
+    {plt_extra_apps, [ssl, public_key, crypto]}
+]}.

rebar.lock

@@ -0,0 +1 @@
+[].

src/grisp_keychain.app.src

@@ -1,6 +1,6 @@
 {application, grisp_keychain, [
-    {description, "An OTP application"},
-    {vsn, "0.1.0"},
+    {description, "Common layer to access secrets and identities on GRiSP devices"},
+    {vsn, semver},
     {registered, []},
     {mod, {grisp_keychain_app, []}},
     {applications, [
@@ -12,5 +12,16 @@
     ]},
     {modules, []},
     {licenses, ["Apache-2.0"]},
-    {links, []}
+    {links, [
+        {"Homepage", "https://www.grisp.io"},
+        {"Changelog", "https://github.com/grisp/grisp_keychain/blob/main/CHANGELOG.md"},
+        {"GitHub", "https://github.com/grisp/grisp_keychain"}
+    ]},
+    {files, [
+        "LICENSE",
+        "README.md",
+        "rebar.*",
+        "include",
+        "src"
+    ]}
  ]}.

src/grisp_keychain.erl

@@ -67,6 +67,7 @@ read_cert(primary, der) ->
 %--- Internal Functions --------------------------------------------------------
 
 -doc false.
+-dialyzer({nowarn_function, delegate_call/2}).
 -spec delegate_call(Function :: atom(), Args :: [term()]) -> term().
 
 delegate_call(Function, Args) ->

src/grisp_keychain_app.erl

@@ -1,8 +1,3 @@
-%%%-------------------------------------------------------------------
-%% @doc grisp_keychain public API
-%% @end
-%%%-------------------------------------------------------------------
-
 -module(grisp_keychain_app).
 
 -behaviour(application).

src/grisp_keychain_filesystem.erl

@@ -1,5 +1,10 @@
 -module(grisp_keychain_filesystem).
 
+-moduledoc """
+Filesystem `api_module` for grisp_keychain
+
+Implements the keychain API for direct filesystem based access to certificates and keys.
+""".
 
 %--- Includes ------------------------------------------------------------------
 
@@ -20,7 +25,7 @@
 %--- API Functions -------------------------------------------------------------
 
 -spec tls_options(DomainName :: atom() | string() | binary() |  undefined)
-    -> ssl:tls_client_option().
+    -> [ssl:tls_client_option()].
 
 tls_options(DomainName) ->
     {CertsKeys, ClientTrustedCerts} =

src/grisp_keychain_sup.erl

@@ -1,8 +1,3 @@
-%%%-------------------------------------------------------------------
-%% @doc grisp_keychain top level supervisor.
-%% @end
-%%%-------------------------------------------------------------------
-
 -module(grisp_keychain_sup).
 
 -behaviour(supervisor).