Skip to content

fix: prepare v1.2.1 patch release with corrected workflows and docume…#10

Merged
beonde merged 1 commit intomainfrom
bugfix/readme-doc-bad-links
Sep 29, 2025
Merged

fix: prepare v1.2.1 patch release with corrected workflows and docume…#10
beonde merged 1 commit intomainfrom
bugfix/readme-doc-bad-links

Conversation

@beonde
Copy link
Member

@beonde beonde commented Sep 29, 2025

🔧 Fix v1.2.1 - Patch Release for Workflow and Documentation Issues

Summary

Critical patch release to fix v1.2.0 deployment issues including immutable release workflows, incorrect binary documentation, and Windows build failures.

🚨 Issues Fixed

GitHub Actions Workflow Issues

  • Immutable Release Problem: Workflow triggered on release: [published] but releases are immutable at that point
  • Binary Upload Failures: Could not attach assets to already-published releases
  • Windows Shell Syntax: PowerShell line continuation errors in Python workflow

Documentation Issues

  • Incorrect Binary Links: README showed old binary names without .tar.gz for macOS/Linux
  • Wrong Installation Commands: Missing tar extraction steps for compressed binaries
  • CI/CD Examples: Outdated commands in workflow examples

🔧 Technical Fixes

Workflow Trigger Fix

# Before (problematic)
on:
  release:
    types: [published]  # Release already immutable

# After (correct)
on:
  release:
    types: [created]    # Allows asset uploads

Windows Shell Syntax Fix

# Before (failed on Windows PowerShell)
npx esbuild src/cli.ts \
  --bundle \
  --platform=node

# After (cross-platform compatible)
npx esbuild src/cli.ts --bundle --platform=node

Binary Download Links Fix

# Before (incorrect)
[capiscio-darwin-x64](https://github.com/.../capiscio-darwin-x64)

# After (correct)
[capiscio-darwin-x64.tar.gz](https://github.com/.../capiscio-darwin-x64.tar.gz)

📦 Version Updates

All package files synchronized to v1.2.1:

  • package.json & package-lock.json
  • python-package/pyproject.toml
  • Workflow default versions
  • CLI dynamic version import (automatically synced)

🛠️ Files Changed

File Changes Purpose
.github/workflows/release-binaries.yml Trigger fix, version update Enable asset uploads to releases
.github/workflows/publish-python.yml Shell syntax fix Fix Windows PowerShell compatibility
README.md Binary links, installation commands Correct user documentation
package.json Version bump to 1.2.1 Version consistency
package-lock.json Version bump to 1.2.1 Lock file sync
python-package/pyproject.toml Version bump to 1.2.1 Python package sync

🚀 Expected Release Process

With these fixes, the v1.2.1 release process will be:

  1. Create v1.2.1 pre-release (triggers workflow while mutable)
  2. Workflows build & upload all 5 binary assets:
    • capiscio-win-x64.exe
    • capiscio-win-arm64.exe
    • capiscio-linux-x64.tar.gz
    • capiscio-darwin-x64.tar.gz
    • capiscio-darwin-arm64.tar.gz
  3. Verify assets uploaded correctly
  4. Remove pre-release tag to publish final release

📋 Testing Checklist

  • ✅ Version consistency across all packages
  • ✅ CLI reports correct version (1.2.1)
  • ✅ README binary links point to correct URLs
  • ✅ Installation commands include tar extraction
  • ✅ Workflow triggers on release creation
  • ✅ Shell commands compatible with Windows PowerShell

🎯 Validation

CLI Version Check

$ node dist/cli.js --version
1.2.1

Binary Download URLs

All links now correctly point to .tar.gz for Unix platforms:

  • Linux: capiscio-linux-x64.tar.gz
  • macOS Intel: capiscio-darwin-x64.tar.gz
  • macOS Apple Silicon: capiscio-darwin-arm64.tar.gz

Installation Commands

# Linux/macOS (updated)
curl -L -o capiscio-linux-x64.tar.gz https://github.com/.../capiscio-linux-x64.tar.gz
tar -xzf capiscio-linux-x64.tar.gz
chmod +x capiscio-linux-x64
./capiscio-linux-x64 --version

⚠️ Breaking Changes

None - This is a documentation and infrastructure fix. No changes to CLI functionality or API.

🔗 Related Issues

Fixes the following v1.2.0 deployment problems:

  • Binary release workflow failures
  • Incorrect documentation leading users to broken download links
  • Python package build failures on Windows platforms

Ready for v1.2.1 release! This patch resolves all deployment blockers and ensures users get working download links and installation instructions.

…ntation

- Bump version to 1.2.1 across all package files
- Fix README binary download links to use correct .tar.gz format for macOS/Linux
- Fix GitHub Actions workflow trigger from 'published' to 'created' to allow asset uploads
- Fix Python workflow Windows shell syntax errors (remove backslash line continuations)
- Update installation commands with proper tar extraction steps
- Update CI/CD examples with correct binary format

This patch release fixes the v1.2.0 release issues:
- Immutable release preventing binary uploads
- Incorrect binary download links in documentation
- Windows PowerShell syntax errors in Python workflow
@beonde beonde merged commit e9bea21 into main Sep 29, 2025
5 checks passed
@beonde beonde deleted the bugfix/readme-doc-bad-links branch September 29, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant