Changes auto-committed by Conductor (#19)

Author: andrasbacsai

HOW-TO-RELEASE.md

@@ -0,0 +1,141 @@
+# How to Release Coolify CLI
+
+This guide explains the release process for the Coolify CLI.
+
+## Prerequisites
+
+- Write access to the `coollabsio/coolify-cli` repository
+- All changes merged to the target branch (`v4.x`)
+- All tests passing (`go test ./internal/...`)
+
+## Release Process
+
+### 1. Update Version Number
+
+Edit `cmd/root.go` and update the `CliVersion` variable:
+
+```go
+var CliVersion = "1.x.x"  // Change to your new version
+```
+
+**Version Format:** Use semantic versioning: `MAJOR.MINOR.PATCH` (e.g., `1.2.3`)
+- **MAJOR**: Breaking changes
+- **MINOR**: New features (backwards compatible)
+- **PATCH**: Bug fixes (backwards compatible)
+
+### 2. Commit and Push Version Change
+
+```bash
+git add cmd/root.go
+git commit -m "chore: bump version to 1.x.x"
+git push origin v4.x
+```
+
+### 3. Create a GitHub Release
+
+1. Go to https://github.com/coollabsio/coolify-cli/releases/new
+2. Click "Choose a tag" and create a new tag:
+   - **Tag name**: `v1.x.x` (must start with `v`, e.g., `v1.2.3`)
+   - **Target**: `v4.x` (or your target branch)
+3. **Release title**: `v1.x.x` (same as tag name)
+4. **Description**: Write release notes describing:
+   - New features
+   - Bug fixes
+   - Breaking changes (if any)
+   - Example:
+     ```markdown
+     ## What's New
+     - Added support for database management
+     - Improved error messages for API failures
+
+     ## Bug Fixes
+     - Fixed panic when config file is missing
+
+     ## Breaking Changes
+     - None
+     ```
+5. Click "Publish release"
+
+### 4. Automated Build Process
+
+Once you publish the release:
+
+1. GitHub Actions automatically triggers the `release-cli.yml` workflow
+2. GoReleaser builds binaries for:
+   - **Linux**: amd64, arm64
+   - **macOS (Darwin)**: amd64, arm64
+   - **Windows**: amd64, arm64
+3. Binaries are automatically uploaded to the release
+4. The release becomes available at:
+   - GitHub: `https://github.com/coollabsio/coolify-cli/releases/tag/v1.x.x`
+   - Install script: `curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash`
+
+### 5. Verify the Release
+
+After the workflow completes (usually 2-5 minutes):
+
+1. Check the release page has all platform binaries
+2. Test the install script:
+   ```bash
+   curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash
+   coolify version
+   ```
+3. Test the auto-update functionality:
+   ```bash
+   # If you have an older version installed
+   coolify update
+   coolify version  # Should show the new version
+   ```
+4. Verify the version matches your release
+
+## Troubleshooting
+
+### Build Failed
+- Check the GitHub Actions logs at https://github.com/coollabsio/coolify-cli/actions
+- Common issues:
+  - Syntax errors in Go code
+  - Test failures
+  - GoReleaser configuration issues
+
+### Version Not Updating
+- Ensure you committed the version change in `cmd/root.go`
+- The tag must start with `v` (e.g., `v1.2.3`, not `1.2.3`)
+- Check that the workflow has write permissions
+
+### Install Script Not Finding New Version
+- Wait a few minutes for GitHub's CDN to update
+- Check that binaries were uploaded to the release
+- Verify the tag format is correct (`v1.x.x`)
+
+## Release Checklist
+
+Before creating a release:
+
+- [ ] All tests pass: `go test ./internal/...`
+- [ ] Code is formatted: `go fmt ./...`
+- [ ] Version updated in `cmd/root.go`
+- [ ] Changes merged to `v4.x` branch
+- [ ] Release notes prepared
+
+After creating a release:
+
+- [ ] GitHub Actions workflow completed successfully
+- [ ] All platform binaries are present on the release page
+- [ ] Install script downloads the new version
+- [ ] `coolify version` returns the correct version
+
+## Configuration Files
+
+The release process uses these configuration files:
+
+- `.goreleaser.yml` - GoReleaser configuration (build matrix, archives, etc.)
+- `.github/workflows/release-cli.yml` - GitHub Actions workflow
+- `scripts/install.sh` - User-facing install script
+- `cmd/root.go` - Contains `CliVersion` variable (line 22)
+
+## Notes
+
+- The CLI has auto-update checking built-in (checks every 10 minutes)
+- Users can manually update with `coolify update`
+- Install script supports version pinning: `bash install.sh v1.2.3`
+- Releases are immutable - if you need to fix something, create a new patch version