Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Sep 12, 2025

This PR implements automatic contributor recognition in the CHANGELOG.md file for each release, addressing the community request to thank contributors similar to the AWS MCP server approach.

What's Changed

🚀 Automatic Contributor Recognition

  • New GitHub Action workflow automatically triggers when releases are published
  • Extracts contributors from git commits and co-author tags between releases
  • Updates CHANGELOG.md with formatted contributor list and release information
  • Supports multiple trigger types: GitHub releases, manual dispatch, and repository_dispatch for Azure DevOps integration

📝 Manual Changelog Generation

  • git-cliff integration with conventional commit parsing for organized changelog generation
  • GitHub API integration to pull contributor information and first-time contributor detection
  • Automatic categorization of changes (Features, Bug Fixes, Documentation, etc.)
  • Creates Pull Request with generated changelog for review

⚙️ Configuration & Documentation

  • Root-level CHANGELOG.md that links to existing server-specific changelogs
  • git-cliff configuration (cliff.toml) tailored for the Microsoft MCP repository
  • Comprehensive documentation explaining the system and how to use it
  • Updated README with contributor recognition section

Integration Benefits

This seamlessly integrates with the existing Azure DevOps release pipeline without requiring any changes. When the pipeline calls gh release create, the GitHub webhook automatically triggers the contributor update workflow.

The implementation also addresses the merge conflict problem mentioned in the issue comments by automating changelog generation, eliminating the need for manual CHANGELOG.md editing.

Example Output

When a release is published, the CHANGELOG.md will be automatically updated with:

## [1.2.0] - 2024-01-15

### Contributors 👥

Thanks to all the contributors who made this release possible:

- [@username1](https://github.com/username1) - *first-time contributor* 🎉
- [@username2](https://github.com/username2)
- John Doe

Conventional Commits Support

The system supports conventional commit prefixes for automatic categorization:

  • feat: → 🚀 Features
  • fix: → 🐛 Bug Fixes
  • docs: → 📚 Documentation
  • perf: → ⚡ Performance
  • And more...

Fixes #156.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits September 12, 2025 17:03
- Add root-level CHANGELOG.md with contributor section
- Create GitHub Action workflow for automatic contributor updates on releases
- Add manual changelog generation workflow using git-cliff
- Include git-cliff configuration with conventional commit support
- Add comprehensive documentation for contributor recognition
- Update README with contributor recognition information
- Support both GitHub releases and repository_dispatch triggers
- Include Co-authored-by recognition for proper attribution

Co-authored-by: weshaggard <9010698+weshaggard@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [COMMUNITY] Auto-Add contributors to CHANGELOG each release feat: implement automatic contributor recognition in CHANGELOG for releases Sep 12, 2025
@Copilot Copilot AI requested a review from weshaggard September 12, 2025 17:06
Copilot finished work on behalf of weshaggard September 12, 2025 17:06
@joshfree joshfree moved this from Untriaged to Not Started in Azure MCP Server Sep 15, 2025
@joshfree joshfree added this to the 2025-10 milestone Oct 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Not Started

Development

Successfully merging this pull request may close these issues.

[COMMUNITY] Auto generate CHANGELOG, including adding contributors for each release

3 participants