mirror of https://github.com/tw93/Mole.git synced 2026-02-05 13:48:48 +00:00

Files

Bhadra 3bd2869e8d feat: Add Windows package manager publishing infrastructure (#343 ) (#356 )

* feat: Add Windows package manager publishing infrastructure (#343)

- Add comprehensive release build scripts:
  - build-release.ps1: Creates portable ZIP + SHA256 checksums
  - build-exe.ps1: Standalone executable builder (PS2EXE)
  - build-msi.ps1: MSI installer builder (WiX Toolset)

- Add GitHub Actions workflow:
  - Automated builds on version tags
  - Runs tests before building
  - Auto-creates GitHub releases with artifacts

- Add package manager manifests:
  - WinGet: Complete manifests ready for microsoft/winget-pkgs
  - Chocolatey: Full package with install/uninstall scripts
  - Scoop: JSON manifest ready for submission

- Add comprehensive documentation:
  - RELEASE.md: Complete guide for building and publishing
  - Package-specific READMEs with submission instructions
  - ISSUE-343-SUMMARY.md: Quick reference and next steps

Successfully tested: Built mole-1.0.0-x64.zip (5 MB) with SHA256 checksums

Addresses #343

* chore: update contributors [skip ci]

* fix: Support uppercase V and -windows suffix in release workflow

* fix: Remove duplicate parameter definitions in clean, optimize, and purge commands

- bin/clean.ps1: Remove duplicate System, GameMedia, DebugMode, Whitelist params
- bin/optimize.ps1: Remove duplicate DebugMode param
- bin/purge.ps1: Remove duplicate DebugMode and Paths params

These duplicates were causing parser errors in tests.

* fix: Update test regex to match --dry-run format in help text

The help output shows --dry-run (kebab-case) but test was checking for DryRun (PascalCase).
Updated regex to accept both formats.

* fix: Handle Pester 5.x result object properties correctly

Pester 5.x uses different property names (Passed.Count, Failed.Count)
instead of PassedCount, FailedCount. Added fallback logic to support both formats.

* fix: Simplify Pester result parsing with better fallback logic

Since Pester already prints test results, just check for failures
and assume success if we can't parse the result object. This handles
different Pester versions more gracefully.

* feat: Add MSI and EXE builds to release workflow

- Install WiX Toolset for MSI creation
- Install PS2EXE module for standalone EXE
- Build all three formats: ZIP, MSI, EXE
- MSI and EXE builds marked optional (continue-on-error)
- Upload all artifacts to GitHub release
- Update release notes with installation instructions for all formats
- Add SHA256 verification instructions for each format

* fix: Resolve MSI and EXE build failures

MSI build fix:
- Use UTF8 without BOM for temp WXS file to avoid XML parsing errors
- WiX compiler requires clean UTF8 encoding without byte order mark

EXE build fix:
- Remove hashtable iteration that modified collection during enumeration
- Exclude null iconFile parameter from ps2exe params instead of removing it
- Prevents 'Collection was modified' exception

* fix: Properly handle encoding and version format for MSI and EXE builds

MSI fix:
- Use System.IO.File.ReadAllText/WriteAllText for consistent UTF8 without BOM
- Prevents XML parsing errors in WiX compiler

EXE fix:
- Extract numeric version only (strip '-windows' suffix) for ps2exe
- ps2exe requires version in format n.n.n.n (numeric only)
- Fallback to 1.0.0.0 if version parsing fails

* fix: Use WriteAllBytes to ensure no BOM in MSI WXS file

- Convert string to UTF8 bytes manually
- Write bytes directly to file
- This guarantees no byte order mark is added
- Prevents WiX XML parsing error at position 7

* fix: Read WXS source as bytes to completely avoid BOM issues

- Read source file as raw bytes
- Convert bytes to string using UTF8Encoding without BOM
- Replace version in string
- Convert back to bytes and write
- This completely avoids PowerShell's Get-Content BOM handling

* chore: Simplify release workflow - remove MSI build, minimal release notes

- Remove MSI build steps (has persistent BOM/encoding issues)
- Remove WiX Toolset installation
- Simplify release notes to bare minimum
- Focus on ZIP and EXE artifacts only

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

2026-01-24 00:08:24 +08:00

tools

feat: Add Windows package manager publishing infrastructure (#343 ) (#356 )

2026-01-24 00:08:24 +08:00

mole.nuspec

feat: Add Windows package manager publishing infrastructure (#343 ) (#356 )

2026-01-24 00:08:24 +08:00

README.md

feat: Add Windows package manager publishing infrastructure (#343 ) (#356 )

2026-01-24 00:08:24 +08:00

README.md

Chocolatey Package for Mole

Quick Submission Guide

1. Prerequisites

Chocolatey account at https://community.chocolatey.org/
API key from your account settings
GitHub release with ZIP file

2. Update Package Files

mole.nuspec:

Update <version>1.0.0</version>
Update <releaseNotes> URL

tools/chocolateyinstall.ps1:

Update $version = '1.0.0'
Update $checksum64 with SHA256 from build

tools/VERIFICATION.txt:

Update all v1.0.0 references
Update checksum

3. Build Package Locally

# Navigate to chocolatey directory
cd packaging\chocolatey

# Pack the package
choco pack

# This creates: mole.1.0.0.nupkg

4. Test Locally

# Install from local package
choco install mole -source . -y

# Test functionality
mole --version
mole clean --dry-run

# Uninstall
choco uninstall mole -y

5. Publish to Chocolatey

# Set API key (one time)
choco apikey --key YOUR_API_KEY --source https://push.chocolatey.org/

# Push package
choco push mole.1.0.0.nupkg --source https://push.chocolatey.org/

# Package will enter moderation queue

Package Structure

chocolatey/
├── mole.nuspec                    # Package metadata
└── tools/
    ├── chocolateyinstall.ps1      # Installation script
    ├── chocolateyuninstall.ps1    # Uninstallation script
    └── VERIFICATION.txt           # Verification instructions

Moderation Process

Submit: Push package to Chocolatey
Auto-scan: Automated virus/malware scan (~5 minutes)
Moderation: Human review (~1-2 weeks for first package)
Approval: Package becomes available
Trusted: After 3+ approved packages, auto-moderation enabled

Updating for New Releases

When releasing v1.0.1:

Update version in 3 files:
- mole.nuspec: <version>1.0.1</version>
- tools/chocolateyinstall.ps1: $version = '1.0.1'
- tools/VERIFICATION.txt: All URLs and hash
Update checksums:
- Get from SHA256SUMS.txt
- Update in chocolateyinstall.ps1 and VERIFICATION.txt

Build and push:

choco pack
choco push mole.1.0.1.nupkg --source https://push.chocolatey.org/

Testing Checklist

Before pushing:

Package builds without errors (choco pack)
Local install works (choco install mole -source .)
Mole commands execute properly
PATH is added correctly
Uninstall cleans up properly
Checksums match GitHub release
URLs are correct and accessible

Common Issues

"Package rejected - URL not accessible"

Ensure GitHub release is public
Test download URL in browser

"Checksum mismatch"

Regenerate checksum: (Get-FileHash mole-1.0.0-x64.zip).Hash
Update both install script and VERIFICATION.txt

"Install script fails"

Test locally first
Check PowerShell syntax: Test-Path tools\chocolateyinstall.ps1

Resources

Chocolatey Docs: https://docs.chocolatey.org/en-us/create/create-packages
Package Guidelines: https://docs.chocolatey.org/en-us/create/create-packages#package-naming-guidelines
Moderation Process: https://docs.chocolatey.org/en-us/community-repository/moderation/
Create Account: https://community.chocolatey.org/account/Register