Skip to content

PUBLISHING_GUIDE.md

Latest commit

 

History

History
319 lines (245 loc) · 8.33 KB

PUBLISHING_GUIDE.md

File metadata and controls

319 lines (245 loc) · 8.33 KB

Publishing MEGAGENT to GitHub Marketplace

This guide walks you through publishing MEGAGENT v1.2.0 to the GitHub Marketplace.

Prerequisites

  • Repository is public
  • All required files are in place (action.yml, README.md, LICENSE)
  • Version 1.2.0 is finalized and tested
  • All tests passing (39/39)
  • Documentation is complete

Step-by-Step Publishing Process

Step 1: Create a Release Tag

# Ensure you're on the main branch with latest changes
git checkout main
git pull origin main

# Merge the release branch
git merge <release-branch>

# Create an annotated tag for v1.2.0
git tag -a v1.2.0 -m "Release version 1.2.0 - Monetization and GitHub Marketplace"

# Push the tag to GitHub
git push origin v1.2.0

Step 2: Create a GitHub Release

  1. Navigate to Releases

  2. Configure Release

    • Tag: Select v1.2.0
    • Release title: MEGAGENT v1.2.0 - Monetization & GitHub Marketplace
    • Description: Copy content from RELEASE_NOTES_v1.2.0.md

  3. Add Build Artifacts (Optional)

    # Build the package locally
python -m build

# Upload dist/megabot-1.2.0-py3-none-any.whl
# Upload dist/megabot-1.2.0.tar.gz

  4. Release Options

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

  5. Publish Release

    • Click "Publish release"

Step 3: Publish to GitHub Marketplace

  1. Access Marketplace Publishing

    • Go to https://github.com/ELMOURABEA/MEGAGENT
    • Click on "Releases" (if not already there)
    • You should see an option to "Draft a release for the Marketplace" or "Publish this Action to the GitHub Marketplace"

    Alternative path:

  2. Action Details

    Basic Information:

    • Action name: MeGAGen-4-all
    • Short description: Unified AI agent integrating GitHub Copilot, Gemini, ChatGPT, and Grok for comprehensive research and automation
    • Icon: ⚡ zap (already in action.yml)
    • Color: blue (already in action.yml)

  3. Categories (Select up to 2)

    • Primary: Automation
    • Secondary: Continuous Integration

  4. Tags (Add relevant keywords)

    ai
artificial-intelligence
automation
copilot
gemini
chatgpt
grok
research
multi-platform
workflow
ci-cd
analysis

  5. Description & Documentation

    • The Marketplace will pull from your README.md
    • Ensure README.md has:
      • Clear installation instructions ✓
      • Usage examples ✓
      • Configuration details ✓
      • Links to documentation ✓

  6. Review Requirements

    • ✅ action.yml present and valid
    • ✅ README.md comprehensive
    • ✅ LICENSE file present (MIT)
    • ✅ No security vulnerabilities
    • ✅ Complies with GitHub's terms of service

  7. Publish

    • Review all information
    • Click "Publish release"
    • The action will be available on the Marketplace!

Step 4: Verify Marketplace Listing

  1. Check Your Listing

  2. Test Installation Create a test repository and workflow:

    # .github/workflows/test-megagent.yml
name: Test MEGAGENT

on: [push]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Test MEGAGENT Action
        uses: ELMOURABEA/MEGAGENT@v1.2.0
        with:
          mode: 'query'
          prompt: 'What is artificial intelligence?'
          tier: 'free'

  3. Monitor Initial Usage

    • Check for issues or feedback
    • Monitor the action's analytics (if available)

Step 5: Update Repository

  1. Add Marketplace Badge to README Already done! The README includes:

    [![Marketplace](https://img.shields.io/badge/GitHub%20Marketplace-MeGAGen--4--all-orange.svg)](https://github.com/marketplace/actions/megagen-4-all)

  2. Add Marketplace Link to Documentation Update any references to include the Marketplace URL.

Step 6: Promote Your Action

  1. Social Media (Optional)

    • Tweet about the release
    • Post on LinkedIn
    • Share in relevant communities

  2. Blog Post (Optional)

    • Write about the features
    • Explain use cases
    • Share integration examples

  3. Community Engagement

    • Monitor Issues and Discussions
    • Respond to user questions
    • Collect feedback for improvements

Troubleshooting

Issue: "Action.yml is invalid"

Solution: Validate YAML syntax

python -c "import yaml; yaml.safe_load(open('action.yml'))"

Issue: "README is not descriptive enough"

Solution: Ensure README has:

  • Clear description
  • Installation instructions
  • Usage examples
  • Input/output documentation

Issue: "Missing LICENSE file"

Solution: The MIT LICENSE is already present at repository root.

Issue: "Icon not displaying"

Solution: Check action.yml branding section:

branding:
  icon: 'zap'
  color: 'blue'

Issue: "Cannot publish - repository is private"

Solution: Make repository public:

  • Settings → General → Danger Zone → Change visibility

Post-Publishing Maintenance

Version Updates

For future releases (e.g., v1.2.1, v1.3.0):

  1. Update version in:

    • setup.py
    • megabot/__init__.py
    • CHANGELOG.md

  2. Create and push new tag:

    git tag -a v1.2.1 -m "Release version 1.2.1"
git push origin v1.2.1

  3. Create new GitHub release

  4. The Marketplace listing will automatically update

Major Version Tags

Create major version tags for easier user reference:

# v1 tag points to latest v1.x.x
git tag -fa v1 -m "Version 1 (latest: 1.2.0)"
git push origin v1 --force

Users can then use:

- uses: ELMOURABEA/MEGAGENT@v1  # Always latest 1.x.x
- uses: ELMOURABEA/MEGAGENT@v1.2  # Latest 1.2.x
- uses: ELMOURABEA/MEGAGENT@v1.2.0  # Specific version

Support Resources

For Users

For Maintainers

GitHub Marketplace Guidelines

Best Practices

  1. Keep README up-to-date with latest features
  2. Respond promptly to issues and questions
  3. Maintain backward compatibility when possible
  4. Use semantic versioning (MAJOR.MINOR.PATCH)
  5. Provide clear migration guides for breaking changes
  6. Include comprehensive examples
  7. Document all inputs and outputs
  8. Test on multiple platforms when possible

Marketplace Policies

  • Comply with GitHub's Terms of Service
  • Respect user privacy and data
  • No malicious code or hidden functionality
  • Clear pricing information (if applicable)
  • Accurate and honest descriptions
  • Proper licensing (MIT in our case)

Checklist for Publishing

  • Code reviewed and tested
  • Version bumped to 1.2.0
  • CHANGELOG updated
  • Release notes created
  • Git tag created and pushed
  • GitHub release created
  • Marketplace listing published
  • Listing verified and tested
  • Documentation updated
  • Community notified (optional)

Success Indicators

After publishing, you should see:

  • ✅ Action appears in Marketplace search
  • ✅ "Use this Action" button works
  • ✅ README displays correctly
  • ✅ Version badge shows v1.2.0
  • ✅ Test workflow runs successfully
  • ✅ No errors in action logs

Next Steps After Publishing

  1. Monitor: Watch for issues and feedback
  2. Engage: Respond to users and community
  3. Improve: Plan next features based on feedback
  4. Maintain: Keep dependencies updated
  5. Promote: Share success stories and use cases

Congratulations! 🎉

Once published, MEGAGENT will be available to millions of GitHub users worldwide!

Questions? Open an issue or check the DOCUMENTATION.md

Ready to publish? Follow the steps above and make MEGAGENT available to the world!