Skip to content

feat(backend): add Swagger generation step to backend CI #55

Description

@GRACENOBLE

Problem

Swagger docs are generated manually via make swagger and committed. If a developer changes handler annotations but forgets to regenerate, CI passes but the committed docs are stale.

Acceptance criteria

  • Add a CI step in backend-ci.yml that runs make swagger and then checks for a clean git diff
  • If the diff is non-empty, fail the job with a message directing the developer to run make swagger locally
  • Document this requirement in backend/docs/swagger.md

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: backendGo REST APIarea: infraCI/CD, infrastructure, deployment, and DevOpspriority: highImportant — address in the current sprinttype: choreCleanup or maintenance tasks

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions