Fix missing @fedify/mysql entries in CONTRIBUTING.md and fedify init#600
Fix missing @fedify/mysql entries in CONTRIBUTING.md and fedify init#600dahlia merged 4 commits intofedify-dev:mainfrom
fedify init#600Conversation
The @fedify/mysql package was omitted from the list of packages in the contributing guide, while all other database adapter packages (@fedify/postgres, @fedify/redis, @fedify/sqlite) were already listed. fedify-dev#587
The mq.json configuration for @fedify/init was missing the MySQL/MariaDB entry, even though the KV store side (kv.json) already had it. This meant that `fedify init` / `npm init @fedify` did not offer MySQL as a message queue backend option when scaffolding a new project. fedify-dev#587
issues-auto-labeler
bot
added
component/build
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses two omissions related to the recently introduced Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request correctly adds the @fedify/mysql package to CONTRIBUTING.md and its message queue configuration to packages/init/src/json/mq.json. The changes are accurate. I have one suggestion regarding the package list in CONTRIBUTING.md to improve maintainability by sorting it alphabetically. A similar sorting improvement could be applied to the package table in README.md.
Note: Security Review has been skipped due to the limited scope of the PR.
Two packages were out of alphabetical order: *packages/nestjs/* and *packages/next/* were listed after *packages/relay/* instead of before *packages/postgres/*, and *packages/fixture/* was at the very end instead of between *packages/fastify/* and *packages/fresh/*.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
|
/gemini review |
There was a problem hiding this comment.
Pull request overview
This PR fixes two oversights left after the @fedify/mysql package was introduced in PRs #597 and #599. It adds the missing packages/mysql/ entry to CONTRIBUTING.md's package list and adds a mysql entry to mq.json so that fedify init can scaffold a MySQL/MariaDB message queue backend.
Changes:
- Added
packages/mysql/*to theCONTRIBUTING.mdpackage directory list (with bonus fixes: correct alphabetical placement ofpackages/fixture,packages/nestjs,packages/next) - Added a
mysqlkey topackages/init/src/json/mq.jsondescribing theMysqlMessageQueuebackend with its dependencies, imports, and example object
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
packages/init/src/json/mq.json |
Adds the mysql MQ backend entry for fedify init scaffolding |
CONTRIBUTING.md |
Adds @fedify/mysql to the package list, fixes alphabetical ordering for @fedify/fixture, @fedify/nestjs, and @fedify/next |
There was a problem hiding this comment.
Code Review
This pull request correctly addresses omissions for the @fedify/mysql package. It updates CONTRIBUTING.md to include the new package and sorts the package list for better organization. It also adds the mysql option to packages/init/src/json/mq.json, enabling fedify init to scaffold projects with MySQL as a message queue backend. The changes are consistent with the project's structure and conventions. I have no further comments.
Note: Security Review has been skipped due to the limited scope of the PR.
Without this, the mysql entries in mq.json and kv.json were silently ignored because the MessageQueue and KvStore types are derived from the MESSAGE_QUEUE and KV_STORE constant arrays respectively, and mysql was not listed in either. As a result, fedify init never offered MySQL/MariaDB as a selectable backend option despite the JSON entries being present. Also added mysql to DB_TO_CHECK and the corresponding db-to-check.json so that the test suite can check whether a MySQL instance is running before running integration tests. fedify-dev#600 (comment)
github-project-automation
bot
moved this from In review
to Done
in STF 2025–2026 Milestone 4: Storage and Infrastructure
Summary
Fixes two omissions left over after the
@fedify/mysqlpackage was added in #597 and #599.*packages/mysql/*to the package list in CONTRIBUTING.md, alongside the other database adapter packages.mysqlas a message queue option in@fedify/init's mq.json, so thatfedify init/npm init @fedifynow offers MySQL/MariaDB as a message queue backend when scaffolding a new project. (The KV store side was already present in kv.json.)Closes #587