docs(#3193): add Forgejo dist-git message requirements - #3194
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Document the message formats, topic names, and required fields that Packit expects from Forgejo dist-git messages delivered via Fedora Messaging. The document covers all four event types (push, pull request, issue/PR comment, and action run) and was compiled by auditing the parsers in packit_service.worker.parser and the event classes in packit_service.events.forgejo. This document is intended to be shared with the Fedora Forge team so they can verify compatibility. Note: pre-commit hooks were not fully run. pre-commit could not complete (network access denied for fetching remote hook repos). prettier was run directly on the changed file. Other hooks (ruff, mypy, shellcheck) do not apply to Markdown files. Closes #3193
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 55s |
betulependule
left a comment
betulependule
left a comment
There was a problem hiding this comment.
This is a helpful summary of the functionality of our current Forgejo parsers, but I wouldn't call it a list of requirements. A list of requirements should include what kind of information we actually require to be present in the payload for Packit to be able to do its job.
This document goes a step beyond that and adds the exact format of those messages and the topic names as a requirement (essentially expecting them to match with the Fedora Forge (upstream) messages). We don't need to require any of this. As long as the required fields are present, we can just simply update the parsers later (though in this case, we would keep the old Forgejo parsers for upstream support later and create a new set of parsers for Forgejo dist-git).
2 participants
Summary
docs/forgejo-message-requirements.mddocumenting the message formats, topic names, and required fields that Packit expects from Forgejo dist-git messages arriving via Fedora Messaging.packit_service.worker.parserand the event classes inpackit_service.events.forgejo.Motivation
Packit's codebase currently assumes Forgejo dist-git messages follow a specific format, but that format is not documented anywhere. The Fedora Forge team has asked Packit to provide a list of requirements so they can verify compatibility. This document serves as that reference.
Testing
Closes #3193
Post-script verification
agent/3193-forgejo-message-requirements)e4e3d293b352520241d3206b374c2e06e8e9399c..HEAD)