Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
111 lines (87 loc) · 3.09 KB

RELEASE_CHECKLIST.md

File metadata and controls

111 lines (87 loc) · 3.09 KB
Raw

Release Checklist for Soft-Mapper v2.0.0

✅ All tasks completed! This library is ready for Composer/Packagist release.

Completed Tasks

1. Package Configuration ✅

  • composer.json properly configured with all required fields
  • Version field removed (uses git tags)
  • Keywords optimized for discoverability
  • Support and documentation links added
  • Validates cleanly: composer validate --strict

2. Git Configuration ✅

  • .gitignore updated to exclude:
    • vendor/
    • composer.lock
    • env.php (database credentials)

3. Documentation Updates ✅

  • CHANGELOG.md: v2.0.0 marked as released (2025-10-30)
  • README.md:
    • Composer installation instructions updated
    • Packagist badges added
    • All badges made clickable
  • RELEASE.md: Complete release guide created

4. Testing ✅

  • test-composer-install.php created and passing
  • Composer autoloader works correctly
  • SoftMapper class properly loaded
  • All required methods present

5. Security ✅

  • No external dependencies to audit
  • CodeQL scan: No issues found
  • Code review: All feedback addressed

6. Quality Checks ✅

  • composer validate --strict: PASSED
  • composer install: WORKS
  • Autoloader generation: WORKS
  • Installation test: ALL TESTS PASS

What Happens Next

After this PR is merged to the main branch:

  1. Create Git Tag

    git checkout main
git pull origin main
git tag -a v2.0.0 -m "Release version 2.0.0 - Major feature update"
git push origin v2.0.0

  2. Create GitHub Release

  3. Submit to Packagist

  4. Configure Auto-Updates

    • Set up GitHub webhook in Packagist settings
    • Future releases will auto-update

  5. Verification

    composer require dedsecteam17/soft-mapper

Files Modified in This Release

  • composer.json - Enhanced with proper metadata
  • .gitignore - Added vendor/ and composer.lock
  • CHANGELOG.md - Marked v2.0.0 as released
  • README.md - Updated installation and badges
  • RELEASE.md - New: Complete release guide
  • test-composer-install.php - New: Installation test script
  • RELEASE_CHECKLIST.md - New: This checklist

Key Features of v2.0.0

This release includes 27 new methods and major ORM enhancements:

  • ✨ Automatic Timestamps
  • ✨ Soft Deletes
  • ✨ ORM Relationships (hasOne, hasMany, belongsTo, belongsToMany)
  • ✨ Eager Loading
  • ✨ Query Scopes
  • ✨ Batch Operations
  • ✨ Transactions
  • ✨ Advanced Queries (whereIn, whereBetween, whereNull, JOINs)
  • ✨ Helper Methods (count, exists, first, pluck)

Contact

For questions or issues:

Status: ✅ Ready for Release Version: 2.0.0 Release Date: 2025-10-30