Skip to content

Commit 3ff85d7

Browse files
committed
Update files
1 parent f6beca6 commit 3ff85d7

8 files changed

Lines changed: 331 additions & 88 deletions

File tree

.github/DESCRIPTION.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# GitHub Repository Description
2+
3+
Use this description for your GitHub repository:
4+
5+
```
6+
A powerful CLI tool written in Go for managing HubSpot contacts. Perform CRUD operations, search, and automate contact management directly from your terminal.
7+
```
8+
9+
## Short Description (for GitHub Topics)
10+
11+
```
12+
CLI tool for HubSpot contact management with CRUD operations, search, and automation capabilities.
13+
```
14+
15+
## Topics/Tags to Add
16+
17+
Add these topics to your repository:
18+
- `hubspot`
19+
- `cli`
20+
- `go`
21+
- `golang`
22+
- `contact-management`
23+
- `crm`
24+
- `command-line`
25+
- `automation`
26+
- `hubspot-api`
27+
- `contacts`
28+
29+
## How to Update Repository Description
30+
31+
1. Go to your repository on GitHub: `https://github.com/obay/hsctl`
32+
2. Click the ⚙️ (Settings) icon or go to Settings
33+
3. Scroll down to "About" section
34+
4. Paste the description above
35+
5. Add the topics listed above
36+
6. Save changes
37+

.github/workflows/scoop-update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
- name: Checkout Scoop Bucket
1212
uses: actions/checkout@v4
1313
with:
14-
repository: obay/hsctl-scoop
14+
repository: obay/scoop-bucket
1515
token: ${{ secrets.SCOOP_BUCKET_TOKEN }}
1616
path: scoop-bucket
1717

.goreleaser.yml

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ builds:
2323
- -s -w -X github.com/obay/hsctl/cmd.version={{.Version}} -X github.com/obay/hsctl/cmd.commit={{.Commit}} -X github.com/obay/hsctl/cmd.buildDate={{.Date}}
2424

2525
archives:
26+
# Versioned archives (standard)
2627
- format: tar.gz
2728
name_template: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}_{{ .Version }}"
2829
files:
@@ -31,6 +32,15 @@ archives:
3132
format_overrides:
3233
- goos: windows
3334
format: zip
35+
# Version-less archives for easier direct downloads via /latest/download/
36+
- format: tar.gz
37+
name_template: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}"
38+
files:
39+
- README.md
40+
- LICENSE
41+
format_overrides:
42+
- goos: windows
43+
format: zip
3444

3545
checksum:
3646
name_template: 'checksums.txt'
@@ -58,16 +68,19 @@ release:
5868
scoop:
5969
bucket:
6070
owner: obay
61-
name: hsctl-scoop
71+
name: scoop-bucket
6272
homepage: "https://github.com/obay/hsctl"
6373
description: "A CLI tool for managing HubSpot contacts"
6474
license: "MIT"
6575
persist:
6676
- config
67-
skip_upload: true # Set to false after creating the scoop bucket repository
77+
skip_upload: false
6878

6979
brews:
7080
- name: hsctl
81+
tap:
82+
owner: obay
83+
name: homebrew-tap
7184
homepage: "https://github.com/obay/hsctl"
7285
description: "A CLI tool for managing HubSpot contacts"
7386
license: "MIT"

GITHUB_SETUP.md

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
# GitHub Repository Setup Guide
2+
3+
This guide will help you set up your GitHub repository with a proper description and ensure downloadable packages are available.
4+
5+
## Step 1: Add Repository Description
6+
7+
1. Go to your repository: `https://github.com/obay/hsctl`
8+
2. Click the **⚙️ Settings** icon (or navigate to Settings)
9+
3. Scroll down to the **"About"** section
10+
4. Click the **✏️ Edit** icon
11+
5. Paste this description:
12+
13+
```
14+
A powerful CLI tool written in Go for managing HubSpot contacts. Perform CRUD operations, search, and automate contact management directly from your terminal.
15+
```
16+
17+
6. Add the following **Topics** (tags):
18+
- `hubspot`
19+
- `cli`
20+
- `go`
21+
- `golang`
22+
- `contact-management`
23+
- `crm`
24+
- `command-line`
25+
- `automation`
26+
- `hubspot-api`
27+
- `contacts`
28+
29+
7. Click **Save changes**
30+
31+
## Step 2: Verify Release Assets
32+
33+
After your first release, GoReleaser will automatically create downloadable packages. Verify that these are available:
34+
35+
### What Gets Created
36+
37+
For each release, GoReleaser creates:
38+
39+
1. **Versioned Archives** (with version number):
40+
- `hsctl_darwin_amd64_v1.0.0.tar.gz`
41+
- `hsctl_darwin_arm64_v1.0.0.tar.gz`
42+
- `hsctl_linux_amd64_v1.0.0.tar.gz`
43+
- `hsctl_linux_arm64_v1.0.0.tar.gz`
44+
- `hsctl_windows_amd64_v1.0.0.zip`
45+
46+
2. **Version-less Archives** (for `/latest/download/` URLs):
47+
- `hsctl_darwin_amd64.tar.gz`
48+
- `hsctl_darwin_arm64.tar.gz`
49+
- `hsctl_linux_amd64.tar.gz`
50+
- `hsctl_linux_arm64.tar.gz`
51+
- `hsctl_windows_amd64.zip`
52+
53+
3. **Package Files**:
54+
- `hsctl_linux_amd64.deb` (Debian/Ubuntu)
55+
- `hsctl_linux_amd64.rpm` (Red Hat/CentOS/Fedora)
56+
57+
4. **Checksums**:
58+
- `checksums.txt` (for verifying downloads)
59+
60+
### Testing Direct Downloads
61+
62+
After creating a release, test these URLs:
63+
64+
```bash
65+
# macOS Intel
66+
curl -LO https://github.com/obay/hsctl/releases/latest/download/hsctl_darwin_amd64.tar.gz
67+
68+
# macOS Apple Silicon
69+
curl -LO https://github.com/obay/hsctl/releases/latest/download/hsctl_darwin_arm64.tar.gz
70+
71+
# Linux
72+
curl -LO https://github.com/obay/hsctl/releases/latest/download/hsctl_linux_amd64.tar.gz
73+
74+
# Windows
75+
curl -LO https://github.com/obay/hsctl/releases/latest/download/hsctl_windows_amd64.zip
76+
```
77+
78+
## Step 3: Create Your First Release
79+
80+
1. **Tag your release**:
81+
```bash
82+
git tag -a v0.1.0 -m "Initial release"
83+
git push origin v0.1.0
84+
```
85+
86+
2. **GitHub Actions will automatically**:
87+
- Build binaries for all platforms
88+
- Create archives (tar.gz and zip)
89+
- Generate package files (.deb, .rpm)
90+
- Create a GitHub release
91+
- Upload all assets
92+
93+
3. **Verify the release**:
94+
- Go to: `https://github.com/obay/hsctl/releases`
95+
- Check that all assets are listed
96+
- Test downloading one of the assets
97+
98+
## Step 4: Update README Links (if needed)
99+
100+
The README already includes direct download links. After your first release, verify that the links work:
101+
102+
- All `/latest/download/` URLs should redirect to the latest release
103+
- Versioned URLs will point to specific releases
104+
- Checksums file should be available
105+
106+
## Troubleshooting
107+
108+
### No Assets in Release
109+
110+
If assets aren't appearing:
111+
1. Check GitHub Actions logs for errors
112+
2. Verify GoReleaser configuration (`.goreleaser.yml`)
113+
3. Ensure the workflow has proper permissions
114+
115+
### Download Links Don't Work
116+
117+
If `/latest/download/` URLs don't work:
118+
1. Verify the asset filenames match exactly
119+
2. Check that the release is marked as "Latest"
120+
3. Ensure the release is published (not draft)
121+
122+
### Missing Package Files
123+
124+
If .deb or .rpm files are missing:
125+
1. Check the `nfpms` section in `.goreleaser.yml`
126+
2. Verify Linux builds are successful
127+
3. Check GitHub Actions logs
128+
129+
## Next Steps
130+
131+
- ✅ Repository description added
132+
- ✅ Topics/tags added
133+
- ✅ First release created
134+
- ✅ Download links verified
135+
- ✅ Package managers set up (Scoop, Homebrew)
136+
137+
Your repository is now ready for users to download and install HSCTL!
138+

INSTALL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This guide provides detailed installation instructions for HSCTL on different pl
1515

1616
1. Add the tap:
1717
```bash
18-
brew tap obay/hsctl
18+
brew tap obay/homebrew-tap
1919
```
2020

2121
2. Install:
@@ -62,7 +62,7 @@ This guide provides detailed installation instructions for HSCTL on different pl
6262

6363
2. Add the bucket:
6464
```powershell
65-
scoop bucket add hsctl https://github.com/obay/hsctl-scoop
65+
scoop bucket add obay https://github.com/obay/scoop-bucket
6666
```
6767

6868
3. Install:

0 commit comments

Comments
 (0)