Skip to content

Commit 95d33ed

Browse files
committed
docs: update Homebrew tap setup - repository already created
1 parent 06d43f8 commit 95d33ed

File tree

1 file changed

+29
-49
lines changed

1 file changed

+29
-49
lines changed

HOMEBREW_TAP_SETUP.md

Lines changed: 29 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,16 @@
11
# Homebrew Tap Setup Instructions
22

3-
## Quick Setup (Step-by-Step)
3+
## ✅ Tap Repository Created!
44

5-
### Step 1: Create Tap Repository on GitHub
5+
The Homebrew tap repository has been created at: **https://github.com/kiku-jw/homebrew-docstripper**
66

7-
1. Go to https://github.com/new
8-
2. Repository name: `homebrew-docstripper`
9-
3. Make it **public**
10-
4. **Don't** initialize with README, .gitignore, or license
11-
5. Click "Create repository"
7+
The formula is already set up and ready. However, you need to create a GitHub release tag before users can install it.
128

13-
### Step 2: Clone and Setup Locally
9+
## Next Steps
1410

15-
```bash
16-
git clone https://github.com/kiku-jw/homebrew-docstripper.git
17-
cd homebrew-docstripper
18-
mkdir -p Formula
19-
```
11+
### Step 1: Create GitHub Release Tag
2012

21-
### Step 3: Copy Formula
22-
23-
```bash
24-
# From DocStripper repo root
25-
cp docstripper.rb Formula/docstripper.rb
26-
cd Formula
27-
```
28-
29-
### Step 4: Create GitHub Release (if not exists)
30-
31-
You need a tagged release for Homebrew. If you don't have v2.1.0 release yet:
13+
Before users can install via Homebrew, you need a tagged release:
3214

3315
```bash
3416
# In DocStripper repo
@@ -39,55 +21,53 @@ git push origin v2.1.0
3921
Then create a GitHub release at: https://github.com/kiku-jw/DocStripper/releases/new
4022
- Tag: v2.1.0
4123
- Title: v2.1.0
42-
- Description: (can be empty)
24+
- Description: (optional)
4325

44-
### Step 5: Update Formula URL
26+
### Step 2: Update Formula with Release SHA256
4527

46-
Edit `Formula/docstripper.rb` and update to point to the release:
47-
48-
```ruby
49-
url "https://github.com/kiku-jw/DocStripper/archive/refs/tags/v2.1.0.tar.gz"
50-
```
51-
52-
### Step 6: Calculate SHA256 Hash
28+
After creating the release, you need to calculate the SHA256 hash and update the formula:
5329

5430
```bash
5531
# Download the release tarball
5632
curl -L https://github.com/kiku-jw/DocStripper/archive/refs/tags/v2.1.0.tar.gz -o docstripper.tar.gz
5733

5834
# Calculate hash
5935
shasum -a 256 docstripper.tar.gz
60-
# Copy the hash (first part before spaces)
61-
```
62-
63-
Update the formula:
64-
```ruby
65-
sha256 "PASTE_HASH_HERE"
36+
# Copy the hash (first part before spaces, without filename)
6637
```
6738

68-
### Step 7: Commit and Push
39+
Then update the formula in the tap repository:
6940

7041
```bash
71-
cd .. # Back to tap repo root
42+
# Clone the tap repo (if not already)
43+
git clone https://github.com/kiku-jw/homebrew-docstripper.git
44+
cd homebrew-docstripper
45+
46+
# Edit Formula/docstripper.rb and update:
47+
# 1. URL should already be correct: url "https://github.com/kiku-jw/DocStripper/archive/refs/tags/v2.1.0.tar.gz"
48+
# 2. Update SHA256: sha256 "PASTE_HASH_HERE"
49+
50+
# Commit and push
7251
git add Formula/docstripper.rb
73-
git commit -m "Add docstripper formula"
52+
git commit -m "Update formula with release SHA256"
7453
git push origin main
7554
```
7655

77-
### Step 8: Test Installation
56+
### Step 3: Test Installation
7857

7958
```bash
80-
# Test locally first
81-
brew install --build-from-source Formula/docstripper.rb
82-
83-
# If successful, users can now install with:
59+
# Test locally
8460
brew tap kiku-jw/docstripper
8561
brew install docstripper
62+
63+
# Verify it works
64+
docstripper --help
8665
```
8766

88-
### Step 9: Update INSTALL.md and README
67+
### Step 4: Users Can Now Install
68+
69+
Once the release is created and SHA256 is updated, users can install with:
8970

90-
Update installation instructions to mention the tap:
9171
```bash
9272
brew tap kiku-jw/docstripper
9373
brew install docstripper

0 commit comments

Comments
 (0)