9ff4876b56
- Add CLI reference documentation with command examples - Add CLI quick reference card for quick lookups - Add troubleshooting guide for common issues - Add GitHub Actions release workflow for binary builds - Add CHANGELOG.md for release tracking - Add webhook integration examples - Add setup and verification script - Update README with installation instructions and CLI overview Addresses ELF-169: Document CLI and add standalone binary releases Co-Authored-By: Paperclip <noreply@paperclip.ing>
2.4 KiB
2.4 KiB
Changelog
All notable changes to Hatch will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]
Added
- CLI documentation with comprehensive command reference
- GitHub Actions release workflow for binary builds
- Standalone binaries for Linux, macOS, and Windows
- SHA256 checksums for all binaries
- SBOM generation for releases
Changed
- Updated README with CLI installation instructions
Fixed
- N/A
[0.1.0] - 2024-01-15
Added
- Initial release of Hatch
- HTTP request capture and storage
- Request inspection and search
- Request replay functionality
- Mock response configuration
- OpenAPI documentation generation
- Web UI for visual inspection
- Docker support with Caddy reverse proxy
- SQLite storage backend
- REST API v1
Changed
- N/A
Fixed
- N/A
[0.0.1] - 2024-01-01
Added
- Project scaffolding
- Basic architecture design
- Development environment setup
Changed
- N/A
Fixed
- N/A
Release Process
Creating a Release
- Update CHANGELOG.md with the new version and changes
- Create a git tag for the version:
git tag -a v1.0.0 -m "Release v1.0.0" git push origin v1.0.0 - GitHub Actions will automatically:
- Build binaries for all platforms
- Create SHA256 checksums
- Generate SBOM
- Create GitHub Release with assets
Manual Release
For manual releases or testing:
# Trigger workflow manually
gh workflow run release.yml -f tag=v1.0.0
# Or create tag and push
git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0
Platform Support
| Platform | Architecture | Binary Name |
|---|---|---|
| Linux | x86_64 | hatch-linux-amd64 |
| Linux | ARM64 | hatch-linux-arm64 |
| macOS | Intel | hatch-darwin-amd64 |
| macOS | Apple Silicon | hatch-darwin-arm64 |
| Windows | x86_64 | hatch-windows-amd64.exe |
Binary Installation
After downloading:
# Linux/macOS
chmod +x hatch-*
sudo mv hatch-* /usr/local/bin/hatch
# Windows (PowerShell)
Rename-Item hatch-windows-amd64.exe hatch.exe
Verification
Verify binary integrity using SHA256 checksums:
# Linux/macOS
sha256sum -c hatch-linux-amd64.sha256
# Windows (PowerShell)
Get-FileHash hatch-windows-amd64.exe -Algorithm SHA256