scribe-org / scribe-org/Scribe-Server
Add a CI check that generated Swagger docs are up to date
Open
Nobody has claimed this yet.
documentation
help wanted
testing
- Dominant language
- Go
- Stars
- 12
- Forks
- 14
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 4
Description
Terms
- I have searched open and closed feature requests
- I agree to follow Scribe-Server's Code of Conduct
Description
Add a CI step running make docs that fails if git diff --exit-code docs/ is dirty, and fix the annotation errors so it starts green.
Contribution
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running make docs and inspecting the generated files under docs/, noting the annotation errors that prevent a clean result. Add the CI step to run make docs and fail when git diff --exit-code docs/ is dirty; done means the annotations are fixed and the check starts green.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, ci-cd
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100