update examples

fluent-ci-templates · Jul 29, 2024 · 194239c · 194239c
1 parent 0e11c09
commit 194239c
Show file tree

Hide file tree

Showing 44 changed files with 1,133 additions and 554 deletions.
diff --git a/docs/examples/coverage/codecov.md → docs/examples/coverage/codecov.mdx b/docs/examples/coverage/codecov.md → docs/examples/coverage/codecov.mdx
@@ -5,22 +5,36 @@ title: Codecov
 
 Run the following command to run the pre-built [Codecov Pipeline](https://github.com/fluent-ci-templates/codecov-pipeline) in your project to upload coverage to [Codecov](https://about.codecov.io/) ☂️:
 
-```bash
-fluentci run codecov_pipeline upload
-```
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run codecov upload`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm codecov upload`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
 
 ## Environment Variables
 
 | Variable      | Description         | Usage    |
-|---------------|---------------------|----------|
+| ------------- | ------------------- | -------- |
 | CODECOV_TOKEN | Your Codecov token. | Required |
 | CODECOV_URL   | Your Codecov URL.   | Optional |
 
 ## Jobs
 
-| Job     | Description                      |
-|---------|----------------------------------|
-| upload  | Uploads coverage to Codecov.     |
+| Job    | Description                  |
+| ------ | ---------------------------- |
+| upload | Uploads coverage to Codecov. |
 
 ## Programmatic usage
 

diff --git a/docs/examples/deploy/chromatic.md → docs/examples/deploy/chromatic.mdx b/docs/examples/deploy/chromatic.md → docs/examples/deploy/chromatic.mdx
@@ -6,9 +6,23 @@ title: Chromatic
 
 Run the following command to run the pre-built [Chromatic Pipeline](https://github.com/fluent-ci-templates/chromatic-pipeline) in your project to publish your storybook to [Chromatic](https://chromatic.com):
 
-```bash
-fluentci run chromatic_pipeline publish
-```
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run chromatic publish`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm chromatic publich`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
 
 ## Environment variables
 

diff --git a/docs/examples/deploy/cloudflare.md → docs/examples/deploy/cloudflare.mdx b/docs/examples/deploy/cloudflare.md → docs/examples/deploy/cloudflare.mdx
@@ -6,9 +6,23 @@ title: Cloudflare
 
 Run the following command to run the pre-built [Cloudflare Pipeline](https://github.com/fluent-ci-templates/cloudflare-pipeline) in your project to deploy your Cloudflare Workers to [Cloudflare](https://cloudflare.com):
 
-```bash
-fluentci run cloudflare_pipeline deploy
-```
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run cloudflare deploy`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm cloudflare deploy`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
 
 ## Environment variables
 
@@ -28,7 +42,7 @@ fluentci run cloudflare_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { deploy } from from "jsr:@fluentci/chromatic";
+import { deploy } from from "jsr:@fluentci/cloudflare";
 
 await deploy();
 

diff --git a/docs/examples/deploy/deno.md → docs/examples/deploy/deno.mdx b/docs/examples/deploy/deno.md → docs/examples/deploy/deno.mdx
@@ -5,9 +5,23 @@ title: Deno
 
 Run the following command to run the pre-built [Deno Pipeline](https://github.com/fluent-ci-templates/deno-pipeline) in your project to deploy to Deno Deploy:
 
-```bash
-fluentci run deno_pipeline deploy
-```
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run deno deploy`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm deno deploy`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
 
 ## Environment variables (Deno Deploy)
 

diff --git a/docs/examples/deploy/firebase.md b/docs/examples/deploy/firebase.md
diff --git a/docs/examples/deploy/firebase.mdx b/docs/examples/deploy/firebase.mdx
@@ -0,0 +1,93 @@
+---
+sidebar_position: 4
+title: Firebase
+---
+
+Run the following command to run the pre-built [Firebase Pipeline](https://github.com/fluent-ci-templates/firebase-pipeline) in your project to deploy your Cloudflare Workers to [Cloudflare](https://cloudflare.com):
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run firebase`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm firebase deploy`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
+
+Or, if you want to use it as a template:
+
+```bash
+fluentci init -t firebase
+```
+
+This will create a `.fluentci` folder in your project.
+
+Now you can run the pipeline with:
+
+```bash
+fluentci run .
+```
+
+Or simply:
+
+```bash
+fluentci
+```
+
+## 🧩 Dagger Module
+
+Use as a [Dagger](https://dagger.io) Module:
+
+```bash
+dagger install github.com/fluent-ci-templates/firebase-pipeline@main
+```
+
+Call a function from the module:
+
+```bash
+dagger call build --src .
+dagger call deploy --src . --token env:FIREBASE_TOKEN
+```
+
+## 🛠️ Environment Variables
+
+| Variable       | Description                |
+| -------------- | -------------------------- |
+| FIREBASE_TOKEN | Your firebase Access Token |
+
+## ✨ Jobs
+
+| Job    | Description                 |
+| ------ | --------------------------- |
+| build  | Build your project.         |
+| deploy | Deploy to firebase hosting. |
+
+```typescript
+build(
+  src: string | Directory | undefined = "."
+): Promise<Directory | string>
+
+deploy(
+  src: string | Directory | undefined = ".",
+  token?: string | Secret
+): Promise<string>
+```
+
+## 👨‍💻 Programmatic usage
+
+You can also use this pipeline programmatically:
+
+```typescript
+import { deploy } from "jsr:@fluentci/firebase";
+
+await deploy(".");
+```
diff --git a/docs/examples/deploy/fly.md b/docs/examples/deploy/fly.md
diff --git a/docs/examples/deploy/fly.mdx b/docs/examples/deploy/fly.mdx
@@ -0,0 +1,46 @@
+---
+sidebar_position: 5
+title: Fly
+---
+
+Run the following command to run the pre-built [Fly Pipeline](https://github.com/fluent-ci-templates/fly-pipeline) in your project to deploy your application to [fly.io](https://fly.io):
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run fly deploy`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm fly deploy`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
+
+## Environment variables
+
+| Variable      | Description        |
+| ------------- | ------------------ |
+| FLY_API_TOKEN | Your Fly API Token |
+
+## Jobs
+
+| Job    | Description                      |
+| ------ | -------------------------------- |
+| deploy | Deploys your application to Fly. |
+
+## Programmatic usage
+
+You can also use this pipeline programmatically:
+
+```typescript
+import { deploy } from "jsr:@fluentci/fly";
+
+await deploy();
+```
diff --git a/docs/examples/deploy/heroku.md b/docs/examples/deploy/heroku.md
diff --git a/docs/examples/deploy/heroku.mdx b/docs/examples/deploy/heroku.mdx
@@ -0,0 +1,47 @@
+---
+sidebar_position: 6
+title: Heroku
+---
+
+Run the following command to run the pre-built [Heroku Pipeline](https://github.com/fluent-ci-templates/heroku-pipeline) in your project to deploy your application to [Heroku](https://www.heroku.com):
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import CodeBlock from "@theme/CodeBlock";
+
+<Tabs>
+  <TabItem value="dagger" label="Dagger">
+    <CodeBlock language="bash">
+      {`fluentci run heroku deploy`}
+    </CodeBlock>
+  </TabItem>
+  <TabItem value="wasm" label="Wasm">
+    <CodeBlock language="bash">
+      {`fluentci run --wasm heroku deploy`}
+
+</CodeBlock>
+</TabItem>
+</Tabs>
+
+## Environment variables
+
+| Variable        | Description         |
+| --------------- | ------------------- |
+| HEROKU_API_KEY  | Your Heroku API Key |
+| HEROKU_APP_NAME | Your Heroku App     |
+
+## Jobs
+
+| Job    | Description                         |
+| ------ | ----------------------------------- |
+| deploy | Deploys your application to Heroku. |
+
+## Programmatic usage
+
+You can also use this pipeline programmatically:
+
+```typescript
+import { deploy } from "jsr:@fluentci/heroku";
+
+await deploy();
+```