Skip to content

RELEASE.md

Latest commit

 

History

History
137 lines (105 loc) · 3.72 KB

RELEASE.md

File metadata and controls

137 lines (105 loc) · 3.72 KB

Creating a Release for GitHub

This guide explains how to create distributable releases of dividex for Mac and Windows and publish them on GitHub.

Quick Start

On macOS (Mac Catalyst)

  1. Build and package the release: 
    ./create-release.sh 1.0.0
    This creates dividex-mac-v1.0.0.zip

On Windows

  1. Build and package the release:

    .\create-release.ps1 1.0.0

    Or using bash (Git Bash/WSL):

    ./create-release.sh 1.0.0 windows

    This creates dividex-windows-v1.0.0.zip

  2. Create GitHub Release:

    • Go to your GitHub repository
    • Click "Releases" → "Create a new release"
    • Tag: v1.0.0
    • Title: dividex v1.0.0
    • Upload both zip files (Mac and Windows)
    • Add release notes and publish

Detailed Steps

Step 1: Build Release Version

On macOS:

./create-release.sh [version] [platform]

Examples:

./create-release.sh 1.0.0          # Builds for Mac (default)
./create-release.sh 1.0.0 mac     # Explicitly build for Mac

On Windows:

Option 1: PowerShell (Recommended)

.\create-release.ps1 1.0.0

Option 2: Bash script (Git Bash/WSL)

./create-release.sh 1.0.0 windows

This will:

  • Build the app in Release mode for the specified platform
  • Create a zip file: dividex-[platform]-v1.0.0.zip
  • Place it in the project root

Step 2: Create GitHub Release

  1. Navigate to your repository on GitHub
  2. Click "Releases" (in the right sidebar, or go to https://github.com/yourusername/dividex/releases)
  3. Click "Create a new release" or "Draft a new release"
  4. Fill in the release form:
    • Choose a tag: Create new tag v1.0.0 (or your version)
    • Release title: dividex v1.0.0
    • Description: Add release notes: 
      ## What's New
- Feature 1
- Feature 2
- Bug fixes

## Installation

### macOS
1. Download `dividex-mac-v1.0.0.zip`
2. Extract the zip file
3. Double-click `dividex.app` to run

### Windows
1. Download `dividex-windows-v1.0.0.zip`
2. Extract the zip file
3. Run `dividex.exe`

**Note (macOS)**: You may need to allow the app in System Settings → Privacy & Security
  5. Attach the zip files: Drag and drop both dividex-mac-v1.0.0.zip and dividex-windows-v1.0.0.zip into the "Attach binaries" area
  6. Click "Publish release"

Step 3: Users Download and Run

Users can now:

  1. Go to your repository's Releases page
  2. Download the appropriate zip file for their platform
  3. Extract it
  4. Run the application:
    • macOS: Double-click dividex.app
    • Windows: Run dividex.exe

Security Note (macOS): Since the app isn't code-signed, macOS may show a security warning. Users need to:

  • Right-click the app → Open (first time only)
  • Or go to System Settings → Privacy & Security → Click "Open Anyway"

File Locations

macOS

  • Release build: bin/Release/net10.0-maccatalyst/maccatalyst-arm64/dividex.app
  • Release zip: dividex-mac-v[version].zip (in project root)

Windows

  • Release build: bin/Release/net10.0-windows10.0.19041.0/win-x64/dividex.exe (or win-x86, win-arm64)
  • Release zip: dividex-windows-v[version].zip (in project root)

Versioning

Use semantic versioning (e.g., 1.0.0, 1.1.0, 2.0.0):

  • Major (2.0.0): Breaking changes
  • Minor (1.1.0): New features, backward compatible
  • Patch (1.0.1): Bug fixes

Automated Releases (Optional)

For automated releases, you can set up GitHub Actions to:

  • Build on every tag push
  • Create releases automatically
  • Upload artifacts

See GitHub Actions documentation for more details.