feat: v1.0.0

.github/workflows/ci.yaml

@@ -0,0 +1,69 @@
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+name: CI
+
+jobs:
+  check:
+    name: Check ${{ matrix.os }}, ${{ matrix.rust }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        rust: [stable, 1.82.0, nightly]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+      - run: cargo check
+
+  test:
+    name: Test Suite ${{ matrix.os }}, ${{ matrix.rust }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        rust: [stable, 1.82.0, nightly]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+      - run: cargo test
+
+  fmt:
+    name: Rustfmt ${{ matrix.os }}, ${{ matrix.rust }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        rust: [stable, 1.82.0, nightly]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+          components: rustfmt
+      - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy ${{ matrix.os }}, ${{ matrix.rust }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        rust: [stable, 1.82.0, nightly]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ matrix.rust }}
+          components: clippy
+      - run: cargo clippy -- -D warnings

.github/workflows/publish-crate.yaml

@@ -3,10 +3,10 @@ on:
     branches:
       - main
     paths:
-      - 'src/**'
-      - '**/Cargo.lock'
-      - '**/Cargo.toml'
-      
+      - "src/**"
+      - "**/Cargo.lock"
+      - "**/Cargo.toml"
+
 name: Publish crate
 
 jobs:
@@ -16,11 +16,10 @@ jobs:
       PROJECT_NAME: aletheia
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
         with:
           toolchain: stable
-          override: true
-      - uses: katyo/publish-crates@v1
+      - uses: katyo/publish-crates@v2
         with:
-          registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+          registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

CHANGELOG.md

@@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 
+## [1.0.0] - 2025-07-02
+
+### Changed
+- [**BREAKING CHANGE**] `GuardianContentClient` no longer needs to be mutable. To account for this change, requests must be built with the `.build_request()` method to be called on the client. An example can be found in the `README.md` file.
+The motivation for this change is to be able to share the client between multiple threads without resorting to synchronisation primitives.
+- The client no longer prints to stderr if the Guardian Content API responds with an error. The client now returns an `Error` variant depending on the type of error, so that downstream consumers can deal with the errors as they wish.
+- Removed the `aletheia::Result<T>` type.
+- Upgraded several dependencies.
+
+### Added
+- Added MSRV to the project
+
+### Fixed
+- The `pages` field in the `SearchResponse` struct is now of type `Option<isize>` (previously `Option<u32>`) to account for the API responding with `-1` when setting the page size to `0` on the client.
+
 ## [0.1.6] - 2022-12-28
 
 ### Added