update docs, add publish action

camflan · Dec 9, 2024 · b42c468 · b42c468
1 parent dd53037
commit b42c468
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 4 deletions.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -0,0 +1,21 @@
+---
+name: Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Publish package
+        run: npx jsr publish
diff --git a/jsr.json b/jsr.json
@@ -1,6 +1,6 @@
 {
   "name": "@camflan/valibot-openapi-generator",
-  "version": "2024.12.13",
+  "version": "2024.12.14",
   "exports": {
     ".": "./mod.ts"
   }

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "valibot-openapi-generator",
-  "version": "2024.12.13",
+  "version": "2024.12.14",
   "description": "",
   "type": "module",
   "sideEffects": false,

diff --git a/src/openapi.ts b/src/openapi.ts
@@ -13,7 +13,7 @@ import type {
 const DEFAULT_TITLE = "Valibot schema documentation";
 const DEFAULT_DESCRIPTION = "Development documentation";
 
-/** getOpenAPISpecs
+/**
  * Combines DescribedRoutes into a single OpenAPI document.
  *
  * @returns OpenAPIV3.Document

diff --git a/src/route.ts b/src/route.ts
@@ -24,7 +24,7 @@ type HandleSchemaOptions = {
   config: OpenAPIRouteHandlerConfig;
 };
 
-/** describeRoute
+/**
  * Creates a route description that will be used by getOpenAPISpecs to combine
  * into a single OpenAPI spec document.
  *