Merge pull request #6 from synadia-io/doc

[Doc] pipelines
synadia-io · Apr 18, 2024 · 48343b2 · 48343b2
2 parents f64d072 + d2a03fd
commit 48343b2
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 11 deletions.
diff --git a/.github/workflows/messagepipelines.yml b/.github/workflows/messagepipelines.yml
@@ -23,7 +23,7 @@ jobs:
         deno-version: [1.42.4]
 
     steps:
-      - name: Git Checkout NHGC
+      - name: Git Checkout messagepipelines
         uses: actions/checkout@v3
         with:
           fetch-depth: 1
@@ -34,12 +34,16 @@ jobs:
           deno-version: ${{ matrix.deno-version }}
 
       - name: Lint Deno Module
-        run: deno fmt --check --ignore=docs/
+        working-directory: messagepipeline
+        run: |
+          deno fmt --check --ignore=docs/
+        
 
       - name: Test Deno Module
+        working-directory: messagepipeline
         env:
           TMPDIR: ${{ runner.temp }}
           CI: true
         run: |
-          deno test --allow-all --unstable --parallel --fail-fast --coverage=./cov nhgc
+          deno test --allow-all --unstable --parallel --fail-fast --coverage=./cov 
 
diff --git a/.github/workflows/messagepipelines_esm.yml b/.github/workflows/messagepipelines_esm.yml
@@ -28,7 +28,8 @@ jobs:
         with:
           deno-version: ${{ matrix.deno-version }}
       - name: Build
-        run: deno bundle messagepipeline/mod.ts messagepipeline/mod.mjs
+        working-directory: messagepipeline
+        run: deno bundle mod.ts mod.mjs
 
       - name: Upload assets to a Release
         uses: AButler/[email protected]

diff --git a/.github/workflows/nhgc.yml b/.github/workflows/nhgc.yml
@@ -34,14 +34,17 @@ jobs:
           deno-version: ${{ matrix.deno-version }}
 
       - name: Lint Deno Module
-        run: deno fmt --check --ignore=docs/
+        working-directory: nhgc
+        run: |
+          deno fmt --check --ignore=docs/
 
       - name: Test Deno Module
+        working-directory: nhgc
         env:
           TMPDIR: ${{ runner.temp }}
           CI: true
           NHG_APIKEY: ${{ secrets.NHG_APIKEY }}
           NHG_URL: ${{ secrets.NHG_URL }}
         run: |
-          deno test --allow-all --unstable --parallel --fail-fast --coverage=./cov nhgc
+          deno test --allow-all --unstable --parallel --fail-fast --coverage=./cov
 
diff --git a/.github/workflows/nhgc_esm.yml b/.github/workflows/nhgc_esm.yml
@@ -28,10 +28,11 @@ jobs:
         with:
           deno-version: ${{ matrix.deno-version }}
       - name: Build
+        working-directory: nhgc
         run: deno bundle nhgc/mod.ts nhgc/mod.mjs
 
       - name: Upload assets to a Release
         uses: AButler/[email protected]
         with:
-          files: nhgc/mod.mjs
+          files: mod.mjs
           repo-token: ${{ secrets.GH_TOKEN }}
diff --git a/messagepipeline/README.md b/messagepipeline/README.md
@@ -99,11 +99,11 @@ if (r.isError) {
 }
 ```
 
-The intention of `Result` is have an efficient pattern for testing if the pipeline
-succeed or failed and preventing errors.
+The intention of `Result` is have an efficient pattern for testing if the
+pipeline succeed or failed and preventing errors.
 
-As you can see, using a Pipeline is very straight forward. It allows you to compose
-repetitive code info a flow that could lead to a simpler handler.
+As you can see, using a Pipeline is very straight forward. It allows you to
+compose repetitive code info a flow that could lead to a simpler handler.
 
 ### Full Example