Skip to content

MARKETPLACE_GUIDE.md

Latest commit

 

History

History
236 lines (189 loc) · 6 KB

MARKETPLACE_GUIDE.md

File metadata and controls

236 lines (189 loc) · 6 KB
Raw

🏪 GitHub Marketplace Publishing Guide

This guide will help you publish the Issue Labler action to the GitHub Marketplace.

📋 Prerequisites

1. Repository Requirements

  • ✅ Public repository
  • ✅ MIT license
  • ✅ Comprehensive README
  • ✅ Action metadata in action.yml
  • ✅ Proper versioning with releases

2. Action Requirements

  • ✅ Self-contained (no external dependencies)
  • ✅ Proper error handling
  • ✅ Rate limiting protection
  • ✅ Input validation
  • ✅ Clear documentation

🚀 Publishing Steps

Step 1: Prepare the Repository

  1. Ensure all files are committed

    git add .
git commit -m "Prepare for marketplace release"
git push origin main

  2. Create a release

    npm run release:patch  # or minor/major

Step 2: Submit to Marketplace

  1. Go to your repository on GitHub
  2. Click Settings → General
  3. Scroll down to Features section
  4. Check Allow GitHub Actions to be created by GitHub Marketplace
  5. Click Save

Step 3: Create Marketplace Listing

  1. Go to GitHub Marketplace
  2. Click Publish an action
  3. Select your repository
  4. Fill out the listing form:

Basic Information

  • Name: GitHub Auto-Label Issues & Templates
  • Description: The most comprehensive GitHub Action for automatic issue labeling, story point detection, and professional issue templates
  • Category: Developer Tools
  • Pricing: Free

Detailed Description

🎯 The Ultimate GitHub Issue Management Solution

Automatically create professional issue templates, detect story points, and apply intelligent labels based on content and file changes. Perfect for mobile development teams, agile projects, and organizations that need consistent issue management across multiple repositories.

✨ Key Features:
• Smart Story Point Detection (1, 2-3, 5, 8, 13, 20+)
• File-Based Labeling for Pull Requests
• Mobile Development Focus (iOS/Android)
• 50+ Professional Labels
• Data-Driven Analysis & Organization
• No External Dependencies

🚀 Perfect for:
• Mobile Development Teams
• Agile Projects
• Enterprise Organizations
• Multi-Repository Management
• DevOps Teams

Screenshots

Add screenshots showing:

  1. Issue templates in action
  2. Automatic labeling results
  3. Data analysis dashboard
  4. Team filtering examples

Usage Examples

# Basic usage
- uses: Devlander-Software/issue-labler@v1
  with:
    create_templates: 'true'
    create_labels: 'true'
    auto_label_issues: 'true'

# Advanced usage with custom settings
- uses: Devlander-Software/issue-labler@v1
  with:
    create_templates: 'true'
    create_labels: 'true'
    auto_label_issues: 'true'
    rate_limit_delay: '1.0'
    max_retries: '5'

📊 Marketplace Optimization

SEO Keywords

  • GitHub issue labeling automation
  • Story point detection GitHub
  • Automatic issue templates
  • GitHub Actions for project management
  • Mobile development labels
  • Agile project management GitHub
  • Issue management automation
  • GitHub workflow automation
  • Pull request labeling
  • Organization-wide GitHub management

Categories & Tags

  • Primary: Developer Tools
  • Secondary: Project Management
  • Tags: github-actions, issue-management, automation, labeling, templates, agile, mobile-development

Target Audience

  • Primary: Development teams using GitHub
  • Secondary: Project managers and DevOps engineers
  • Tertiary: Open source maintainers

📈 Marketing Strategy

1. Documentation

  • ✅ Comprehensive README
  • ✅ Usage examples
  • ✅ Screenshots and demos
  • ✅ Troubleshooting guide

2. Social Proof

  • ✅ Star the repository
  • ✅ Create demo repositories
  • ✅ Write blog posts
  • ✅ Share on social media

3. Community Engagement

  • ✅ Respond to issues quickly
  • ✅ Accept feature requests
  • ✅ Provide support
  • ✅ Create tutorials

🎯 Success Metrics

Short-term (1-3 months)

  • 100+ stars on GitHub
  • 50+ downloads from marketplace
  • 10+ positive reviews
  • 5+ community contributions

Medium-term (3-6 months)

  • 500+ stars on GitHub
  • 200+ downloads from marketplace
  • 25+ positive reviews
  • Featured in GitHub blog/community

Long-term (6+ months)

  • 1000+ stars on GitHub
  • 500+ downloads from marketplace
  • 50+ positive reviews
  • Industry recognition

🔧 Post-Publishing Tasks

1. Monitor & Respond

  • Check marketplace reviews daily
  • Respond to GitHub issues within 24 hours
  • Monitor download statistics

2. Iterate & Improve

  • Collect user feedback
  • Implement requested features
  • Fix reported bugs
  • Improve documentation

3. Promote

  • Share on social media
  • Write blog posts
  • Present at conferences
  • Create video tutorials

📝 Review Process

GitHub will review your action for:

  • ✅ Security best practices
  • ✅ Code quality
  • ✅ Documentation completeness
  • ✅ Marketplace guidelines compliance

Review time: 1-2 weeks

🎉 Success Checklist

Before submitting:

  • All tests pass
  • Documentation is complete
  • Examples work correctly
  • Action is self-contained
  • Error handling is robust
  • Rate limiting is implemented
  • Input validation is thorough
  • README is comprehensive
  • Screenshots are included
  • Usage examples are clear

🚨 Common Issues

Rejection Reasons

  1. Incomplete documentation
  2. Security vulnerabilities
  3. Poor error handling
  4. Missing examples
  5. External dependencies

Solutions

  1. Document everything thoroughly
  2. Use security best practices
  3. Implement comprehensive error handling
  4. Provide working examples
  5. Make action self-contained

📞 Support

If you need help with the publishing process:

Good luck with your marketplace listing! 🚀