OpenAPITools / OpenAPITools/openapi-generator
[BUG] Documents up to date check does not seem to be working
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
The "Documents up to date" step does not appear to be working correctly. The only git diff found was where I added the required MD file. It complains about "uncommitted changes" even though I have already committed the document changes to the PR branch.
I ran the script ensure-up-to-date in bin/utils with no result.
Please see here: https://github.com/Abrhm7786/openapi-generator/pull/3
I would imagine that this step should only check whether certain files have been updated. If they have not, the error message in the build should indicate which ones are missing. It seems that the overall behaviour is wrong but at the very least we have rather poor error messages / instructions on how to proceed here.
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 with bin/utils/ensure-up-to-date and reproduce the check using the changes described in PR #3. Compare the committed document changes with the script's reported uncommitted changes, then verify that the check behaves correctly and identifies any missing files or provides actionable error instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- build-system, ci-cd
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100