Skip to content

RELEASE.md

Latest commit

 

History

History
115 lines (86 loc) · 3.06 KB

RELEASE.md

File metadata and controls

115 lines (86 loc) · 3.06 KB

Release Guide for Entropy-Pass

This guide explains how to upload Entropy-Pass to GitHub and create a release.

Step 1: Create GitHub Repository

  1. Go to GitHub and sign in
  2. Click the "+" icon in the top right → "New repository"
  3. Fill in the details:
    • Repository name: entropy-pass
    • Description: "Ultra-secure password generator with multi-source entropy"
    • Visibility: Public
    • DO NOT initialize with README (we already have one)
  4. Click "Create repository"

Step 2: Push Code to GitHub

# Add the remote repository (replace 'yourusername' with your GitHub username)
git remote add origin https://github.com/yourusername/entropy-pass.git

# Push the code
git branch -M main
git push -u origin main

Step 3: Create a Release

  1. Go to your repository on GitHub
  2. Click "Releases" in the right sidebar
  3. Click "Create a new release"
  4. Fill in the release details:
    • Tag version: v0.1.0
    • Release title: Entropy-Pass v0.1.0 - Initial Release
    • Description: Copy from CHANGELOG.md

Step 4: Upload Release Assets

Attach these files to the release:

Windows Installer (Recommended)

  • File: src-tauri/target/release/bundle/msi/Entropy-Pass_0.1.0_x64_en-US.msi
  • Size: ~7 MB
  • Description: Windows installer - double-click to install

Portable Executable

  • File: src-tauri/target/release/entropy-pass.exe
  • Size: ~7 MB
  • Description: Portable version - no installation required

NSIS Installer (Alternative)

  • File: src-tauri/target/release/bundle/nsis/Entropy-Pass_0.1.0_x64-setup.exe
  • Size: ~7 MB
  • Description: Alternative Windows installer

Step 5: Publish Release

  1. Check "Set as the latest release"
  2. Click "Publish release"

Step 6: Update README

After creating the release, update the README.md to point to the correct release URL:

Download the latest release from the [Releases](https://github.com/yourusername/entropy-pass/releases) page

Release Checklist

Before creating a release, ensure:

  • All tests pass (cargo test and npm test)
  • Application builds successfully (npm run tauri build)
  • Executable runs without errors
  • All features work as expected
  • README.md is up to date
  • CHANGELOG.md is updated
  • Version numbers are correct in:
    • package.json
    • src-tauri/Cargo.toml
    • src-tauri/tauri.conf.json
  • LICENSE file is present
  • .gitignore excludes build artifacts

Post-Release

After publishing:

  1. Test the download links
  2. Share on social media / Reddit / HackerNews
  3. Add topics to the repository:
    • password-generator
    • security
    • rust
    • tauri
    • react
    • typescript
    • desktop-app
    • windows

Future Releases

For subsequent releases:

  1. Update version numbers
  2. Update CHANGELOG.md
  3. Create a new tag: git tag v0.2.0
  4. Push the tag: git push origin v0.2.0
  5. Create a new release on GitHub
  6. Upload new build artifacts

Ready to share your secure password generator with the world! 🚀