|
| 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 | + |
0 commit comments