Skip to content

Update docs #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jaeyson merged 6 commits into from
Apr 12, 2026
Merged

Update docs #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
85829e9
Update docs
jaeyson Mar 8, 2026
601efac
Merge branch 'main' into 89-update-docs
Apr 12, 2026
6e9ff50
Merge branch 'main' into 89-update-docs
Apr 12, 2026
d272d4e
update CI
jaeyson Apr 12, 2026
2a8b766
add PR CI protection rules
jaeyson Apr 12, 2026
0e05a3a
update README.md
jaeyson Apr 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions .github/workflows/ci_v26.0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ jobs:
# - [actions skip]

test:
if: ${{ (github.event_name == 'push' || github.event_name == 'pull_request') && github.repository == 'jaeyson/ex_typesense' }}
runs-on: ubuntu-latest
environment: review

env:
MIX_ENV: test
Expand Down Expand Up @@ -48,10 +50,10 @@ jobs:

steps:
- name: Checkout repo
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

- name: Check for misspellings
uses: codespell-project/actions-codespell@v2
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579

- name: Start Typesense
run: |
Expand Down Expand Up @@ -89,17 +91,20 @@ jobs:
echo "Typesense healthcheck elapsed: ${elapsed}s"

- name: Setup Elixir/OTP
uses: erlef/setup-beam@v1
uses: erlef/setup-beam@fc68ffb90438ef2936bbb3251622353b3dcb2f93
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}

- name: Cache dependencies/builds
uses: actions/cache@v4
- name: Restore cache
id: cache_restore
uses: actions/cache/restore@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp}}-${{ matrix.elixir}}-mix-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
Expand Down Expand Up @@ -137,5 +142,17 @@ jobs:
run: mix test --only ${{ matrix.typesense }}:true --trace

- name: Post test coverage to Coveralls
run: mix coveralls.github --only ${{ matrix.typesense }}:true --trace
if: ${{ matrix.lint && github.ref == 'refs/heads/main' }}
run: mix coveralls.github
if: ${{ matrix.lint && github.event_name == 'push' && github.ref == 'refs/heads/main' }}

- name: Save cache
id: cache_save
uses: actions/cache/save@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: |
${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
31 changes: 24 additions & 7 deletions .github/workflows/ci_v27.0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ jobs:
# - [actions skip]

test:
if: ${{ (github.event_name == 'push' || github.event_name == 'pull_request') && github.repository == 'jaeyson/ex_typesense' }}
runs-on: ubuntu-latest
environment: review

env:
MIX_ENV: test
Expand Down Expand Up @@ -48,10 +50,10 @@ jobs:

steps:
- name: Checkout repo
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

- name: Check for misspellings
uses: codespell-project/actions-codespell@v2
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579

- name: Start Typesense
run: |
Expand Down Expand Up @@ -89,17 +91,20 @@ jobs:
echo "Typesense healthcheck elapsed: ${elapsed}s"

- name: Setup Elixir/OTP
uses: erlef/setup-beam@v1
uses: erlef/setup-beam@fc68ffb90438ef2936bbb3251622353b3dcb2f93
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}

- name: Cache dependencies/builds
uses: actions/cache@v4
- name: Restore cache
id: cache_restore
uses: actions/cache/restore@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp}}-${{ matrix.elixir}}-mix-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
Expand Down Expand Up @@ -137,5 +142,17 @@ jobs:
run: mix test --only ${{ matrix.typesense }}:true --trace

- name: Post test coverage to Coveralls
run: mix coveralls.github --only ${{ matrix.typesense }}:true --trace
if: ${{ matrix.lint && github.ref == 'refs/heads/main' }}
run: mix coveralls.github
if: ${{ matrix.lint && github.event_name == 'push' && github.ref == 'refs/heads/main' }}

- name: Save cache
id: cache_save
uses: actions/cache/save@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: |
${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
31 changes: 24 additions & 7 deletions .github/workflows/ci_v27.1.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ jobs:
# - [actions skip]

test:
if: ${{ (github.event_name == 'push' || github.event_name == 'pull_request') && github.repository == 'jaeyson/ex_typesense' }}
runs-on: ubuntu-latest
environment: review

env:
MIX_ENV: test
Expand Down Expand Up @@ -48,10 +50,10 @@ jobs:

steps:
- name: Checkout repo
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

- name: Check for misspellings
uses: codespell-project/actions-codespell@v2
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579

- name: Start Typesense
run: |
Expand Down Expand Up @@ -89,17 +91,20 @@ jobs:
echo "Typesense healthcheck elapsed: ${elapsed}s"

- name: Setup Elixir/OTP
uses: erlef/setup-beam@v1
uses: erlef/setup-beam@fc68ffb90438ef2936bbb3251622353b3dcb2f93
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}

- name: Cache dependencies/builds
uses: actions/cache@v4
- name: Restore cache
id: cache_restore
uses: actions/cache/restore@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp}}-${{ matrix.elixir}}-mix-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
Expand Down Expand Up @@ -137,5 +142,17 @@ jobs:
run: mix test --only ${{ matrix.typesense }}:true --trace

- name: Post test coverage to Coveralls
run: mix coveralls.github --only ${{ matrix.typesense }}:true --trace
if: ${{ matrix.lint && github.ref == 'refs/heads/main' }}
run: mix coveralls.github
if: ${{ matrix.lint && github.event_name == 'push' && github.ref == 'refs/heads/main' }}

- name: Save cache
id: cache_save
uses: actions/cache/save@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: |
${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
61 changes: 24 additions & 37 deletions .github/workflows/ci_v28.0.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ jobs:
# - [actions skip]

test:
if: ${{ (github.event_name == 'push' || github.event_name == 'pull_request') && github.repository == 'jaeyson/ex_typesense' }}
runs-on: ubuntu-latest
environment: review

env:
MIX_ENV: test
Expand All @@ -40,18 +42,18 @@ jobs:
- typesense: '28.0'
otp: '28'
elixir: '1.19'
lint: true
lint: false

services:
typesense:
image: typesense/typesense:${{ matrix.typesense }}

steps:
- name: Checkout repo
uses: actions/checkout@v6
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd

- name: Check for misspellings
uses: codespell-project/actions-codespell@v2
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579

- name: Start Typesense
run: |
Expand Down Expand Up @@ -89,17 +91,20 @@ jobs:
echo "Typesense healthcheck elapsed: ${elapsed}s"

- name: Setup Elixir/OTP
uses: erlef/setup-beam@v1
uses: erlef/setup-beam@fc68ffb90438ef2936bbb3251622353b3dcb2f93
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}

- name: Cache dependencies/builds
uses: actions/cache@v4
- name: Restore cache
id: cache_restore
uses: actions/cache/restore@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
path: |
deps
_build
priv/plts
key: ${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp}}-${{ matrix.elixir}}-mix-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-typesense-${{ matrix.typesense}}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
Expand Down Expand Up @@ -133,39 +138,21 @@ jobs:
run: mix format --check-formatted
if: ${{ matrix.lint }}

- name: Restore PLT cache
id: plt_cache
uses: actions/cache/restore@v4
with:
key: |
plt-${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
plt-${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-
path: |
priv/plts
if: ${{ matrix.lint }}
- name: Run tests
run: mix test --only ${{ matrix.typesense }}:true --trace

- name: Create PLTs
if: ${{ steps.plt_cache.outputs.cache-hit != 'true' && matrix.lint }}
run: mix dialyzer --plt
- name: Post test coverage to Coveralls
run: mix coveralls.github
if: ${{ matrix.lint && github.event_name == 'push' && github.ref == 'refs/heads/main' }}

- name: Save PLT cache
id: plt_cache_save
uses: actions/cache/save@v4
if: ${{ steps.plt_cache.outputs.cache-hit != 'true' && matrix.lint }}
- name: Save cache
id: cache_save
uses: actions/cache/save@668228422ae6a00e4ad889ee87cd7109ec5666a7
if: ${{ matrix.lint }}
with:
key: |
plt-${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-${{ hashFiles('**/mix.lock') }}
path: |
deps
_build
priv/plts

- name: Dialyzer
run: mix dialyzer --format github --format dialyxir
if: ${{ matrix.lint }}

- name: Run tests
run: mix test --only ${{ matrix.typesense }}:true --trace

- name: Post test coverage to Coveralls
run: mix coveralls.github --only ${{ matrix.typesense }}:true --trace
if: ${{ matrix.lint && github.ref == 'refs/heads/main' }}
key: |
${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
Loading
Loading