chore(release): Reorganize release files into dedicated release directory

wimdecorte · wimdecorte · commit b0543e5b7878 · 2025-12-23T12:52:16.000-05:00
- Move VERSION file to release/ directory for centralized management
- Move RELEASE_NOTES_v1.0.0.md to release/ directory
- Move GITHUB_RELEASE_TEMPLATE.md to release/ directory
- Move prepare-release.sh to release/ directory
- Add FOLDER_STRUCTURE.md documenting release directory organization
- Add README.md with release management documentation and usage instructions
- Update prepare-release.sh to handle new directory structure and paths
- Update GITHUB_RELEASE_TEMPLATE.md with corrected file paths
- Keep project root clean by consolidating all release-related files in one location
- Improves project organization and makes release management more maintainable
diff --git a/release/FOLDER_STRUCTURE.md b/release/FOLDER_STRUCTURE.md
@@ -0,0 +1,90 @@
+# Release Folder Structure
+
+## Overview
+The `release/` folder contains all GitHub release management files, keeping the project root clean and organized.
+
+## Folder Contents
+
+```
+release/
+├── README.md                    # Release management documentation
+├── VERSION                      # Current version (1.0.0)
+├── RELEASE_NOTES_v1.0.0.md     # Comprehensive v1.0.0 release notes
+├── GITHUB_RELEASE_TEMPLATE.md   # Step-by-step GitHub release instructions
+├── prepare-release.sh           # Automated release preparation script
+└── FOLDER_STRUCTURE.md          # This file
+```
+
+## Benefits of This Organization
+
+### Clean Project Root
+- Keeps release-specific files separate from core project files
+- Maintains focus on essential project files (README, scripts, configs)
+- Reduces clutter in the main directory
+
+### Organized Release Management
+- All release-related files in one location
+- Easy to find and maintain release documentation
+- Clear separation between development and release processes
+
+### Scalable Structure
+- Easy to add future release versions
+- Can accommodate multiple release formats
+- Supports automated release workflows
+
+## Usage
+
+### From Release Directory
+```bash
+cd release
+./prepare-release.sh
+```
+
+### From Project Root
+```bash
+release/prepare-release.sh
+```
+
+## File Purposes
+
+### `README.md`
+- Documents the release process
+- Explains how to use the release scripts
+- Provides version history
+
+### `VERSION`
+- Contains current version number (1.0.0)
+- Used by scripts for version consistency
+- Single source of truth for version
+
+### `RELEASE_NOTES_v1.0.0.md`
+- Comprehensive release notes for v1.0.0
+- Used as GitHub release description
+- Documents features, fixes, and changes
+
+### `GITHUB_RELEASE_TEMPLATE.md`
+- Step-by-step GitHub release instructions
+- Complete process documentation
+- Social media and announcement templates
+
+### `prepare-release.sh`
+- Automated release preparation
+- Validates project state
+- Creates release archives and checksums
+- Provides GitHub release instructions
+
+### `FOLDER_STRUCTURE.md`
+- Documents this folder organization
+- Explains benefits and usage
+- Maintains documentation consistency
+
+## Future Releases
+
+For future releases:
+1. Update `VERSION` file
+2. Create new `RELEASE_NOTES_vX.X.X.md`
+3. Update `prepare-release.sh` if needed
+4. Run preparation script
+5. Follow GitHub release template
+
+This structure supports the project's growth while maintaining organization and clarity.
diff --git a/release/GITHUB_RELEASE_TEMPLATE.md b/release/GITHUB_RELEASE_TEMPLATE.md
@@ -7,7 +7,7 @@
 - **Target Branch**: `main`
 
 ## Release Description
-Copy the entire content from `RELEASE_NOTES_v1.0.0.md` into the GitHub release description.
+Copy the entire content from `release/RELEASE_NOTES_v1.0.0.md` into the GitHub release description.
 
 ## Release Assets
 Upload these 4 files from `/tmp/`:
@@ -36,7 +36,7 @@ Upload these 4 files from `/tmp/`:
 - **Target**: `main` branch
 
 ### 3. Add Release Description
-Copy and paste the entire content from `RELEASE_NOTES_v1.0.0.md`
+Copy and paste the entire content from `release/RELEASE_NOTES_v1.0.0.md`
 
 ### 4. Upload Release Assets
 Drag and drop or select these files from `/tmp/`:
diff --git a/release/README.md b/release/README.md
@@ -0,0 +1,73 @@
+# Release Management
+
+This directory contains all files related to GitHub release management for the FileMaker Security Updater project.
+
+## Files
+
+### Release Documentation
+- **`RELEASE_NOTES_v1.0.0.md`** - Comprehensive release notes for v1.0.0
+- **`GITHUB_RELEASE_TEMPLATE.md`** - Step-by-step instructions for creating GitHub releases
+- **`VERSION`** - Current version number (1.0.0)
+
+### Release Scripts
+- **`prepare-release.sh`** - Automated release preparation script
+  - Verifies all required files are present
+  - Runs test suite validation
+  - Creates release archives (tar.gz and zip)
+  - Generates SHA256 checksums
+  - Provides GitHub release instructions
+
+## Usage
+
+### Preparing a Release
+
+1. **Run the preparation script**:
+   ```bash
+   cd release
+   ./prepare-release.sh
+   ```
+
+2. **Follow the generated instructions** to create the GitHub release
+
+3. **Upload the generated assets** from `/tmp/`:
+   - `filemaker-security-updater-v1.0.0.tar.gz`
+   - `filemaker-security-updater-v1.0.0.zip`
+   - `filemaker-security-updater-v1.0.0.tar.gz.sha256`
+   - `filemaker-security-updater-v1.0.0.zip.sha256`
+
+### Creating Future Releases
+
+1. **Update VERSION file** with new version number
+2. **Create new release notes** following the format of `RELEASE_NOTES_v1.0.0.md`
+3. **Update prepare-release.sh** if needed for new version
+4. **Run preparation script** and follow instructions
+
+## Release Process
+
+The release process follows these steps:
+
+1. **Pre-Release Validation**
+   - Verify all required files exist
+   - Run complete test suite
+   - Check git status for uncommitted changes
+
+2. **Archive Creation**
+   - Create temporary directory with release files
+   - Generate tar.gz and zip archives
+   - Calculate SHA256 checksums
+
+3. **GitHub Release**
+   - Create new release with appropriate tag
+   - Upload release assets
+   - Copy release notes as description
+   - Mark as latest release
+
+## Security Considerations
+
+- **Checksums**: Always verify SHA256 checksums for downloaded releases
+- **Signatures**: Future releases may include GPG signatures
+- **Assets**: Only download official release assets from GitHub releases page
+
+## Version History
+
+- **v1.0.0** (December 23, 2024) - Initial release addressing CVE-2025-46295
diff --git a/release/RELEASE_NOTES_v1.0.0.md b/release/RELEASE_NOTES_v1.0.0.md
diff --git a/release/VERSION b/release/VERSION
diff --git a/release/prepare-release.sh b/release/prepare-release.sh
@@ -10,6 +10,9 @@ RELEASE_TAG="v${VERSION}"
 echo "🚀 Preparing GitHub Release: ${RELEASE_NAME}"
 echo "=================================================="
 
+# Change to project root directory
+cd "$(dirname "$0")/.."
+
 # Verify we're in the right directory
 if [[ ! -f "README.md" ]] || [[ ! -f "replace-filemaker-jars-macos.sh" ]]; then
     echo "❌ Error: Not in the correct project directory"
@@ -20,8 +23,8 @@ fi
 echo "📋 Checking core files..."
 REQUIRED_FILES=(
     "README.md"
-    "VERSION"
-    "RELEASE_NOTES_v1.0.0.md"
+    "release/VERSION"
+    "release/RELEASE_NOTES_v1.0.0.md"
     "TODO.md"
     "replace-filemaker-jars-windows.ps1"
     "replace-filemaker-jars-macos.sh"
@@ -118,8 +121,8 @@ mkdir -p "$TEMP_DIR"
 # Copy essential files for release
 echo "  📋 Copying files to archive..."
 cp README.md "$TEMP_DIR/"
-cp VERSION "$TEMP_DIR/"
-cp RELEASE_NOTES_v1.0.0.md "$TEMP_DIR/"
+cp release/VERSION "$TEMP_DIR/"
+cp release/RELEASE_NOTES_v1.0.0.md "$TEMP_DIR/"
 cp TODO.md "$TEMP_DIR/"
 cp replace-filemaker-jars-*.sh "$TEMP_DIR/"
 cp replace-filemaker-jars-*.ps1 "$TEMP_DIR/"
@@ -178,7 +181,7 @@ echo "  3. ${ARCHIVE_NAME}.tar.gz.sha256"
 echo "  4. ${ARCHIVE_NAME}.zip.sha256"
 echo ""
 echo "📝 Release Description:"
-echo "Use the content from RELEASE_NOTES_v1.0.0.md"
+echo "Use the content from release/RELEASE_NOTES_v1.0.0.md"
 
 # Final verification
 echo ""
