Skip to content

RELEASE.md

Latest commit

 

History

History
105 lines (82 loc) · 3.17 KB

RELEASE.md

File metadata and controls

105 lines (82 loc) · 3.17 KB

Release Guide for Quick Scroll Plugin

Pre-Release Checklist

1. Code Quality

  • All linter errors resolved
  • Plugin functionality tested
  • Settings working correctly
  • Cross-platform compatibility verified

2. Documentation

  • README.md updated with proper description
  • Installation instructions clear
  • Usage examples provided
  • Troubleshooting section added

3. Version Management

  • Version bumped to 1.0.0 in all files:
    • manifest.json
    • package.json
    • versions.json

4. Build Configuration

  • GitHub Actions workflow created (.github/workflows/release.yml)
  • esbuild config properly set up
  • .gitignore excludes build artifacts

Release Process

Step 1: Create and Push Git Tag

# Ensure all changes are committed
git add .
git commit -m "Prepare for v1.0.0 release"

# Create and push the tag
git tag v1.0.0
git push origin v1.0.0

Step 2: GitHub Actions Automation

The workflow will automatically:

  1. Build the plugin using npm run build
  2. Package the release files (manifest.json, main.js, styles.css, versions.json)
  3. Create a GitHub release with the tag
  4. Upload the release files as attachments

Step 3: Verify Release

  • Check GitHub Actions workflow completed successfully
  • Verify release files are attached to the GitHub release
  • Test the release by downloading and installing manually

Release Files Structure

Release v1.0.0 should contain:
├── manifest.json      (Plugin metadata)
├── main.js           (Compiled plugin code)
├── styles.css        (Plugin styles)
└── versions.json     (Version compatibility)

Post-Release Tasks

1. Community Plugin Submission

2. Documentation Updates

  • Update any external documentation
  • Create release notes on GitHub
  • Update plugin description if needed

3. Monitoring

  • Monitor for user feedback and issues
  • Track download statistics
  • Respond to community questions

Troubleshooting Release Issues

Build Failures

  • Check Node.js version compatibility
  • Verify all dependencies are properly installed
  • Check for TypeScript compilation errors

Release Creation Issues

  • Ensure GitHub Actions has proper permissions
  • Verify the tag format matches workflow expectations
  • Check if the release already exists

File Upload Issues

  • Confirm all required files are present in the build
  • Check file sizes and formats
  • Verify GitHub Actions artifact upload succeeded

Next Steps After Release

  1. Monitor Feedback: Watch for user issues and feature requests
  2. Plan Updates: Consider what improvements to make for v1.1.0
  3. Community Engagement: Respond to questions and support requests
  4. Feature Development: Work on enhancements based on user feedback

Remember: The first release is a milestone! Take time to celebrate and engage with the community.