Merge pull request #48 from typesense/add-typesense-publish-workflow

Add typesense publish workflow

Author: jasonbosco

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Publish to crates.io
+on:
+  push:
+    tags: ['v*']  # Triggers when pushing tags starting with 'v'
+  workflow_dispatch:  # Allows manual triggering of the workflow
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write     # Required for OIDC token exchange
+    steps:
+    - uses: actions/checkout@v4
+    - uses: rust-lang/crates-io-auth-action@v1
+      id: auth
+
+    - name: Publish typesense_derive
+      run: cargo publish 
+      working-directory: typesense_derive
+    
+    - name: Publish typesense_codegen
+      run: cargo publish 
+      working-directory: typesense_codegen
+    
+    - name: Publish typesense
+      run: cargo publish
+      working-directory: typesense

Cargo.toml

@@ -4,3 +4,17 @@ members = [
     "typesense_derive",
     "typesense_codegen"
 ]
+
+resolver = "3"
+
+[workspace.package]
+version = "0.3.0"
+edition = "2024"
+license = "Apache-2.0"
+repository = "https://github.com/typesense/typesense-rust"
+authors = ["Typesense  <contact@typesense.org>"]
+
+[workspace.dependencies]
+
+typesense_derive = { path = "./typesense_derive", version = "0.3.0" }
+typesense_codegen = { path = "./typesense_codegen", version = "0.25.0" }

typesense/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "typesense"
-version = "0.1.0"
-authors = ["Typesense  <contact@typesense.org>"]
-edition = "2018"
-license = "Apache-2.0"
-description = "WIP client for typesense"
-repository = "https://github.com/typesense/typesense-rust"
+version.workspace = true
+authors.workspace = true
+repository.workspace = true
+edition.workspace = true
+license.workspace = true
+description = "Client for typesense"
 
 [features]
 default = ["derive"]
@@ -24,8 +24,8 @@ hmac = "0.12"
 serde = { version = "1", features = ["derive"] }
 serde_json = "1.0"
 sha2 = "0.10"
-typesense_derive = { version = "0.1.0", path = "../typesense_derive", optional = true }
-typesense_codegen = { version = "0.25.0", path = "../typesense_codegen" }
+typesense_derive = { workspace = true, optional = true }
+typesense_codegen = { workspace = true }
 
 [dev-dependencies]
 dotenvy = "0.15"

typesense/src/document.rs

@@ -4,7 +4,7 @@
 //! A document to be indexed in a given collection must conform to the schema of the collection.
 //!
 use crate::collection_schema::CollectionSchema;
-use serde::{de::DeserializeOwned, Serialize};
+use serde::{Serialize, de::DeserializeOwned};
 
 /// Trait that should implement every struct that wants to be represented as a Typesense
 /// Document

typesense/src/keys.rs

@@ -2,7 +2,7 @@
 //!
 //! More info [here](https://typesense.org/docs/0.20.0/api/api-keys.html).
 
-use base64::{engine::general_purpose::STANDARD as Base64Engine, Engine};
+use base64::{Engine, engine::general_purpose::STANDARD as Base64Engine};
 use core::fmt;
 use hmac::{Hmac, Mac};
 use serde::{Deserialize, Serialize};
@@ -29,7 +29,7 @@ pub async fn generate_scoped_search_key(
     let digest = Base64Engine.encode(result.into_bytes());
 
     let key_prefix = &key.as_ref()[0..4];
-    let raw_scoped_key = format!("{}{}{}", digest, key_prefix, params);
+    let raw_scoped_key = format!("{digest}{key_prefix}{params}");
 
     Ok(Base64Engine.encode(raw_scoped_key.as_bytes()))
 }

typesense/tests/api/collection.rs

@@ -2,8 +2,8 @@
 
 use super::Config;
 use serde::{Deserialize, Serialize};
-use typesense::document::Document;
 use typesense::Typesense;
+use typesense::document::Document;
 use typesense_codegen::apis::collections_api;
 use typesense_codegen::models::{CollectionResponse, CollectionSchema};
 

typesense/tests/api/documents.rs

@@ -2,9 +2,9 @@
 
 use super::Config;
 use serde::{Deserialize, Serialize};
+use typesense::Typesense;
 use typesense::document::Document;
 use typesense::models::SearchParameters;
-use typesense::Typesense;
 use typesense_codegen::apis::documents_api;
 
 #[derive(Typesense, Serialize, Deserialize)]

typesense/tests/derive/collection.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
-use typesense::document::Document;
 use typesense::Typesense;
+use typesense::document::Document;
 
 #[test]
 fn derived_document_generates_schema() {

typesense_codegen/Cargo.toml

@@ -1,10 +1,11 @@
 [package]
 name = "typesense_codegen"
-version = "0.25.0"
-authors = ["OpenAPI Generator team and contributors"]
-description = "client for typesense generated with openapi spec"
-edition = "2018"
-license = "Apache-2.0"
+version = "0.25.1"
+description = "Types for typesense generated with openapi spec"
+authors.workspace = true
+repository.workspace = true
+edition.workspace = true
+license.workspace = true
 
 [dependencies]
 serde = "^1.0"

typesense_codegen/src/apis/analytics_api.rs

@@ -8,7 +8,7 @@
  * Generated by: https://openapi-generator.tech
  */
 
-use super::{configuration, Error};
+use super::{Error, configuration};
 use crate::apis::ResponseContent;
 
 /// struct for typed errors of method [`create_analytics_rule`]
@@ -62,7 +62,7 @@ pub async fn create_analytics_rule(
     if let Some(ref local_var_apikey) = local_var_configuration.api_key {
         let local_var_key = &local_var_apikey.key;
         let local_var_value = match local_var_apikey.prefix {
-            Some(ref local_var_prefix) => format!("{} {}", local_var_prefix, local_var_key),
+            Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"),
             None => local_var_key.clone(),
         };
         local_var_req_builder =
@@ -114,7 +114,7 @@ pub async fn delete_analytics_rule(
     if let Some(ref local_var_apikey) = local_var_configuration.api_key {
         let local_var_key = &local_var_apikey.key;
         let local_var_value = match local_var_apikey.prefix {
-            Some(ref local_var_prefix) => format!("{} {}", local_var_prefix, local_var_key),
+            Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"),
             None => local_var_key.clone(),
         };
         local_var_req_builder =
@@ -165,7 +165,7 @@ pub async fn retrieve_analytics_rule(
     if let Some(ref local_var_apikey) = local_var_configuration.api_key {
         let local_var_key = &local_var_apikey.key;
         let local_var_value = match local_var_apikey.prefix {
-            Some(ref local_var_prefix) => format!("{} {}", local_var_prefix, local_var_key),
+            Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"),
             None => local_var_key.clone(),
         };
         local_var_req_builder =
@@ -211,7 +211,7 @@ pub async fn retrieve_analytics_rules(
     if let Some(ref local_var_apikey) = local_var_configuration.api_key {
         let local_var_key = &local_var_apikey.key;
         let local_var_value = match local_var_apikey.prefix {
-            Some(ref local_var_prefix) => format!("{} {}", local_var_prefix, local_var_key),
+            Some(ref local_var_prefix) => format!("{local_var_prefix} {local_var_key}"),
             None => local_var_key.clone(),
         };
         local_var_req_builder =