Skip to content

Commit 8ab2c70

Browse files
committed
Update changelog and fix tarball naming conventions for consistency
1 parent 8d3dd13 commit 8ab2c70

4 files changed

Lines changed: 42 additions & 40 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,4 +163,5 @@ test_tarball/
163163
.cache/
164164
AGENTS.md
165165
CLAUDE.md
166-
EXP1_CONVERSION_PLAN.md
166+
EXP1_CONVERSION_PLAN.md
167+
release-*/

dev/package-tarballs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ VERSION="${1:-$(date +%Y%m%d)}"
88
"$ROOT_DIR/dev/static-build.sh" "$VERSION"
99

1010
# Source tarball for review/compilation.
11-
TAR_SRC="protoHack-source-$VERSION.tar.gz"
11+
TAR_SRC="protoHack-$VERSION-source.tar.gz"
1212
tar --numeric-owner -czf "$ROOT_DIR/$TAR_SRC" \
1313
-C "$ROOT_DIR" \
1414
original \

dev/prepare-release.sh

Lines changed: 26 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ mkdir -p "$RELEASE_DIR"
2626
"$PROJECT_ROOT/dev/package-tarballs.sh" "$VERSION"
2727

2828
BINARY_TAR="protoHack-${VERSION}-linux-x86_64-static.tar.gz"
29-
SOURCE_TAR="protoHack-source-${VERSION}.tar.gz"
29+
SOURCE_TAR="protoHack-${VERSION}-source.tar.gz"
3030

3131
# Move artifacts into release directory
3232
mv -f "$PROJECT_ROOT/$BINARY_TAR" "$RELEASE_DIR/"
@@ -60,41 +60,31 @@ if [ -f "$CHANGELOG_FILE" ]; then
6060
fi
6161

6262
printf "%b\n" "${BLUE}[2/2] Writing release notes template...${NC}"
63-
cat > "$RELEASE_DIR/RELEASE_NOTES.md" << EOF
64-
# protoHack ${VERSION}
65-
66-
## Downloads
67-
68-
- **Linux Static Binary**: ${BINARY_TAR}
69-
- Statically linked, runs on x86_64 Linux
70-
- No dependencies required
71-
72-
- **Source Code**: ${SOURCE_TAR}
73-
- Full source for building on any platform
74-
- Requires CMake, C compiler, and ncurses
75-
76-
## Verification
77-
78-
Verify downloads with SHA256 checksums:
79-
80-
```bash
81-
sha256sum -c SHA256SUMS
82-
```
83-
84-
## What's New
85-
86-
${CHANGELOG_CONTENT:-"- See docs/CHANGELOG.md"}
87-
88-
## Building from Source
89-
90-
```bash
91-
tar xzf ${SOURCE_TAR}
92-
cd protoHack-${VERSION}
93-
cmake -B build -DCMAKE_BUILD_TYPE=Release
94-
cmake --build build
95-
./build/hack
96-
```
97-
EOF
63+
{
64+
printf "# protoHack %s\n\n" "$VERSION"
65+
printf "## Downloads\n\n"
66+
printf -- "- **Linux Static Binary**: %s\n" "$BINARY_TAR"
67+
printf " - Statically linked, runs on x86_64 Linux\n"
68+
printf " - No dependencies required\n\n"
69+
printf -- "- **Source Code**: %s\n" "$SOURCE_TAR"
70+
printf " - Full source for building on any platform\n"
71+
printf " - Requires CMake, C compiler, and ncurses\n\n"
72+
printf "## Verification\n\n"
73+
printf "Verify downloads with SHA256 checksums:\n\n"
74+
printf '%s\n' '```bash'
75+
printf '%s\n' "sha256sum -c SHA256SUMS"
76+
printf '%s\n\n' '```'
77+
printf '%s\n\n' "## What's New"
78+
printf '%s\n\n' "${CHANGELOG_CONTENT:-See docs/CHANGELOG.md}"
79+
printf '%s\n\n' "## Building from Source"
80+
printf '%s\n' '```bash'
81+
printf 'tar xzf %s\n' "$SOURCE_TAR"
82+
printf 'cd protoHack-%s\n' "$VERSION"
83+
printf '%s\n' "cmake -B build -DCMAKE_BUILD_TYPE=Release"
84+
printf '%s\n' "cmake --build build"
85+
printf '%s\n' "./build/hack"
86+
printf '%s\n' '```'
87+
} > "$RELEASE_DIR/RELEASE_NOTES.md"
9888

9989
printf "%b\n" "${GREEN}=== Release Assets Created Successfully ===${NC}"
10090
printf "%b\n" "Release directory: ${BLUE}${RELEASE_DIR}/${NC}"

docs/CHANGELOG.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
# Changelog
22

3-
All notable changes to this project will be documented in this file.
3+
All notable changes to protoHack will be documented in this file.
44

5-
## 2026-02-06
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
7+
## [0.1.1] - 2026-02-07
8+
9+
### Changed
10+
11+
- macOS compatibility: disable non-PIE compile/link flags on Apple platforms to avoid trace traps.
12+
- Link `crypt` only when a separate `CRYPT_LIB` is found (supports platforms where `crypt()` is in libc).
13+
- Increased lock/save path buffer sizes to support longer usernames.
14+
- Increased directory buffer sizes to accommodate longer path components.
15+
16+
## [0.1.0] - 2026-02-06
617

718
### Added
819

0 commit comments

Comments
 (0)