Skip to content

Commit 8e6f54c

Browse files
blink-so[bot]f0ssel
andcommitted
streamline RELEASES.md to focus only on release process
Removed all development-related content from RELEASES.md: ## Removed Sections - Local Development (Makefile usage, build scripts) - Development Builds (GitHub Actions artifacts) - Manual cross-compilation examples - Build troubleshooting - Version injection examples ## Kept Release-Focused Content - Automated release process (git tag workflow) - Supported platforms table - Release process for maintainers - Version naming conventions - Installation from GitHub releases - Release troubleshooting The file now focuses exclusively on: 1. How to cut a release (git tag v1.0.0) 2. What gets built and released 3. How users install releases 4. Troubleshooting release issues Development information belongs in README.md or separate docs, not in a release-focused document. Co-authored-by: f0ssel <[email protected]>
1 parent b5ec06a commit 8e6f54c

File tree

1 file changed

+2
-85
lines changed

1 file changed

+2
-85
lines changed

RELEASES.md

Lines changed: 2 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ git push origin v1.0.0
1616

1717
This triggers the **Release** workflow which:
1818
1. Builds binaries for all supported platforms
19-
2. Creates compressed archives (`.tar.gz` for Unix, `.zip` for Windows)
19+
2. Creates compressed archives (`.tar.gz` for Unix)
2020
3. Creates a GitHub release with all binaries attached
2121
4. Generates release notes with download instructions
2222

@@ -29,91 +29,14 @@ This triggers the **Release** workflow which:
2929
| macOS | Intel | `jail-darwin-amd64` | `.tar.gz` |
3030
| macOS | Apple Silicon | `jail-darwin-arm64` | `.tar.gz` |
3131

32-
### Development Builds
33-
34-
Every push to `main` and every PR automatically builds binaries available as **GitHub Actions artifacts**:
35-
36-
1. Go to the **Actions** tab
37-
2. Click on the latest **Build Binaries** workflow run
38-
3. Scroll down to **Artifacts** section
39-
4. Download the binary for your platform
40-
41-
Artifacts are kept for 30 days.
42-
43-
## Local Development
44-
45-
### Using Makefile (Recommended)
46-
47-
The project includes a Makefile with common development tasks:
48-
49-
```bash
50-
# Build for current platform
51-
make build
52-
53-
# Build for all platforms
54-
make build-all
55-
56-
# Run tests
57-
make test
58-
59-
# Run tests with coverage
60-
make test-coverage
61-
62-
# Clean build artifacts
63-
make clean
64-
65-
# Format code
66-
make fmt
67-
68-
# Lint code
69-
make lint
70-
```
71-
72-
**Note**: The `lint` target requires [golangci-lint](https://golangci-lint.run/) to be installed.
73-
74-
### Quick Build
75-
76-
Build for your current platform:
77-
78-
```bash
79-
go build -o jail .
80-
```
81-
82-
### Cross-Platform Build Script
83-
84-
Use the provided script to build for all platforms:
85-
86-
```bash
87-
./scripts/build.sh
88-
```
89-
90-
This creates a `build/` directory with binaries for all supported platforms.
91-
92-
### Manual Cross-Platform Build
93-
94-
```bash
95-
# Linux x64
96-
GOOS=linux GOARCH=amd64 go build -o jail-linux-amd64 .
97-
98-
# macOS ARM64 (Apple Silicon)
99-
GOOS=darwin GOARCH=arm64 go build -o jail-darwin-arm64 .
100-
```
101-
102-
### Build with Version Info
103-
104-
```bash
105-
VERSION="v1.0.0"
106-
go build -ldflags="-X main.version=$VERSION" -o jail .
107-
```
108-
10932
## Release Process
11033

11134
### For Maintainers
11235

11336
1. **Prepare Release**:
11437
- Ensure all changes are merged to `main`
11538
- Update version in relevant files if needed
116-
- Test the build locally: `./scripts/build.sh`
39+
- Test the build locally
11740

11841
2. **Create Release**:
11942
```bash
@@ -153,12 +76,6 @@ jail --help
15376

15477
## Troubleshooting
15578

156-
### Build Issues
157-
158-
- **Go version**: Ensure you're using Go 1.25+
159-
- **Dependencies**: Run `go mod download` and `go mod verify`
160-
- **Cross-compilation**: Some platforms may require specific build tags
161-
16279
### Release Issues
16380

16481
- **Tag not triggering release**: Ensure tag follows `v*` pattern

0 commit comments

Comments
 (0)