From 7ee42aed2f1f957255118c6c34fdc8270eeb9584 Mon Sep 17 00:00:00 2001
From: Mrudul Killedar <90367225+Mrudul111@users.noreply.github.com>
Date: Tue, 11 Feb 2025 04:48:05 +0530
Subject: [PATCH 1/3] Update packaging.md
updating the readme file for installation of apidash using homebrew
---
doc/dev_guide/packaging.md | 55 +++++++++++++++++++++++++++++++++++++-
1 file changed, 54 insertions(+), 1 deletion(-)
diff --git a/doc/dev_guide/packaging.md b/doc/dev_guide/packaging.md
index b174131d..6543a9b0 100644
--- a/doc/dev_guide/packaging.md
+++ b/doc/dev_guide/packaging.md
@@ -21,8 +21,61 @@ TODO Instructions
TODO Instructions
## Homebrew
+# apidash Homebrew Formula Submission
-TODO Instructions
+## 1. Prepare Tap Repository
+```
+# Create Homebrew tap
+gh repo create homebrew-tap --public --clone
+mkdir -p homebrew-tap/Formula
+cd homebrew-tap
+```
+
+## 2. Package apidash
+```
+# Build macOS bundle
+flutter build macos
+
+# Create versioned tarball
+tar -czvf apidash-v1.0.0.tar.gz \
+ -C build/macos/Build/Products/Release/ \
+ Apidash.app
+
+# Generate SHA256 checksum
+shasum -a 256 apidash-v1.0.0.tar.gz
+```
+
+## 3. Create Formula File
+`Formula/apidash.rb`:
+```
+class Apidash < Formula
+ desc "Modern API dashboard for developers"
+ homepage "https://apidash.dev"
+ url "https://github.com/<user>/<repo>/releases/download/v1.0.0/apidash-v1.0.0.tar.gz"
+ sha256 "PASTE_YOUR_SHA256_HERE"
+
+ def install
+ prefix.install "Apidash.app"
+ bin.write_exec_script prefix/"Apidash.app/Contents/MacOS/Apidash"
+ end
+
+ test do
+ system "#{bin}/Apidash", "--version"
+ end
+end
+```
+
+## 4. Local Validation
+```
+# Check formula syntax
+brew audit --strict Formula/apidash.rb
+
+# Test installation
+brew install --build-from-source Formula/apidash.rb
+
+# Verify execution
+brew test apidash
+```
## Chocolatey
From 60e7c86aaf31e08474cd6cbf01326801b84d9809 Mon Sep 17 00:00:00 2001
From: Mrudul Killedar <90367225+Mrudul111@users.noreply.github.com>
Date: Tue, 11 Feb 2025 13:14:04 +0530
Subject: [PATCH 2/3] upload and installation also added
---
doc/dev_guide/packaging.md | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/doc/dev_guide/packaging.md b/doc/dev_guide/packaging.md
index 6543a9b0..efbd9148 100644
--- a/doc/dev_guide/packaging.md
+++ b/doc/dev_guide/packaging.md
@@ -75,6 +75,22 @@ brew install --build-from-source Formula/apidash.rb
# Verify execution
brew test apidash
+```
+## 5. Custom Tap Submission
+```
+# Commit formula to your tap repo
+git add Formula/Apidash.rb
+git commit -m "added apidash formula"
+git push
+
+# Create release for tarball
+gh release create v1.0.0 apidash-v1.0.0.tar.gz
+```
+## 6. Installation
+```
+brew tap homebrew-tap/Formula
+brew install apidash
+
```
## Chocolatey
From 5638511a32d2aa3530108a6cff82facaaa30bbe4 Mon Sep 17 00:00:00 2001
From: Ashita Prasad <ashitaprasad92@gmail.com>
Date: Wed, 12 Feb 2025 20:20:35 +0530
Subject: [PATCH 3/3] Update packaging.md
---
doc/dev_guide/packaging.md | 25 +++++++++++++++++--------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/doc/dev_guide/packaging.md b/doc/dev_guide/packaging.md
index efbd9148..8516a209 100644
--- a/doc/dev_guide/packaging.md
+++ b/doc/dev_guide/packaging.md
@@ -21,9 +21,11 @@ TODO Instructions
TODO Instructions
## Homebrew
-# apidash Homebrew Formula Submission
-## 1. Prepare Tap Repository
+Homebrew Formula Submission
+
+### 1. Prepare Tap Repository
+
```
# Create Homebrew tap
gh repo create homebrew-tap --public --clone
@@ -31,7 +33,8 @@ mkdir -p homebrew-tap/Formula
cd homebrew-tap
```
-## 2. Package apidash
+### 2. Package apidash
+
```
# Build macOS bundle
flutter build macos
@@ -45,8 +48,10 @@ tar -czvf apidash-v1.0.0.tar.gz \
shasum -a 256 apidash-v1.0.0.tar.gz
```
-## 3. Create Formula File
+### 3. Create Formula File
+
`Formula/apidash.rb`:
+
```
class Apidash < Formula
desc "Modern API dashboard for developers"
@@ -65,7 +70,8 @@ class Apidash < Formula
end
```
-## 4. Local Validation
+### 4. Local Validation
+
```
# Check formula syntax
brew audit --strict Formula/apidash.rb
@@ -76,7 +82,9 @@ brew install --build-from-source Formula/apidash.rb
# Verify execution
brew test apidash
```
-## 5. Custom Tap Submission
+
+### 5. Custom Tap Submission
+
```
# Commit formula to your tap repo
git add Formula/Apidash.rb
@@ -86,11 +94,12 @@ git push
# Create release for tarball
gh release create v1.0.0 apidash-v1.0.0.tar.gz
```
-## 6. Installation
+
+### 6. Installation
+
```
brew tap homebrew-tap/Formula
brew install apidash
-
```
## Chocolatey