Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
189 lines (129 loc) · 4.15 KB

RELEASE_CHECKLIST.md

File metadata and controls

189 lines (129 loc) · 4.15 KB

GitHub Release Checklist - v1.0.0

✅ Pre-Release Checklist

Code & Build

  • All tests passing (379/379)
  • Code compiled successfully
  • JAR file built: study-library-1.0.0.jar
  • No critical bugs
  • Documentation updated

Documentation Files

  • README.md - Updated with latest info
  • USER_GUIDE.md - Complete user manual
  • DEVELOPMENT.md - Developer documentation
  • PROJECT_SUMMARY.md - Project overview
  • TESTING_PLAN.md - Testing documentation
  • CHANGELOG.md - Created for v1.0.0
  • RELEASE_NOTES.md - Created for v1.0.0
  • LICENSE - MIT License added

Git & Version Control

  • All changes committed
  • Repository pushed to GitHub
  • Git tag created: v1.0.0
  • Tag pushed to remote

Release Assets

  • JAR file ready: target/study-library-1.0.0.jar
  • Shell scripts included: run.sh, run.bat
  • Optional: Screenshots captured
  • Optional: Demo GIF created

📋 Release Steps

1. Commit All Changes

cd /Users/wahidulazam/projects/DocumentVault
git add .
git commit -m "Release v1.0.0 - Initial stable release"
git push origin main

2. Create and Push Git Tag

# Create annotated tag
git tag -a v1.0.0 -m "Version 1.0.0 - Initial Release

Study Library Manager v1.0.0 features:
- Complete CRUD for 4 item types (Notes, PDFs, Media, Snippets)
- Real-time search and filtering
- Category and tag management
- Auto-save with JSON storage
- 379 passing tests with 85%+ coverage
- Modern JavaFX UI with keyboard shortcuts
- Cross-platform (macOS, Windows, Linux)
"

# Push tag to GitHub
git push origin v1.0.0

3. Create GitHub Release

Go to: https://github.com/bmsujon/DocumentVault/releases/new

Tag: v1.0.0
Release Title: Study Library Manager v1.0.0 - Initial Release 🎉

Description: Copy from RELEASE_NOTES.md

Attach Files:

  1. Upload: target/study-library-1.0.0.jar
  2. GitHub will auto-include: Source code (zip) and Source code (tar.gz)

Options:

  • Set as the latest release
  • Set as a pre-release (unchecked - this is stable)
  • Create a discussion for this release (optional)

Click: "Publish release"

🎯 Post-Release Tasks

Immediate

  • Verify release appears on GitHub
  • Test download link works
  • Verify JAR file runs correctly
  • Check release notes display properly

Communication

  • Share on your portfolio/website
  • Post on LinkedIn (if applicable)
  • Share on Twitter/X (if applicable)
  • Update resume/CV with project

Marketing (Optional)

  • Submit to Product Hunt
  • Post on Reddit r/java, r/opensource
  • Share in relevant Discord/Slack communities
  • Write blog post about the project

Monitoring

  • Watch for GitHub issues
  • Monitor download statistics
  • Gather user feedback
  • Plan for v1.1 based on feedback

📦 Release Artifacts

After release, these will be available:

  1. study-library-1.0.0.jar (61 KB)

    • Executable JAR file
    • Requires Java 17+

  2. Source code (zip)

    • Complete source code archive
    • Auto-generated by GitHub

  3. Source code (tar.gz)

    • Complete source code archive
    • Auto-generated by GitHub

🔗 Important Links

💡 Tips

For Users

  • Make sure Java 17+ is installed
  • Download the JAR file directly
  • Run with: java -jar study-library-1.0.0.jar
  • Read USER_GUIDE.md for help

For Developers

  • Clone the repository
  • Build with: mvn clean install
  • Run tests with: mvn test
  • See DEVELOPMENT.md for details

🎉 Release Complete!

Once you've completed all steps above, your project will be:

  • ✅ Published on GitHub
  • ✅ Available for download
  • ✅ Properly versioned and documented
  • ✅ Ready for users and contributors

Congratulations on your first release! 🎊

Version: 1.0.0
Release Date: October 27, 2025
Status: Ready for Release