fix: generation of openapi spec when there are no changes #1304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dnephin
force-pushed
the
dnephin/openapi-spec-date
branch
3 times, most recently
from
2715f62
to
374f010
Compare
mxyng
reviewed
Mar 23, 2022
| return fmt.Errorf("failed to write schema: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func WriteOpenAPISpecToFile(filename string) error { | ||
| old, err := readOpenAPISpec(filename) | ||
| fh, err := os.Create(filename) |
There was a problem hiding this comment.
does this need to be explicitly closed?
There was a problem hiding this comment.
Ah yes, it definitely does need to be closed. Good catch!
mxyng
approved these changes
Mar 23, 2022
dnephin
force-pushed
the
dnephin/openapi-spec-date
branch
2 times, most recently
from
9ad0a30
to
b7d66ce
Compare
Using reflect.Equal does not appear to work, there must be differences between how the spec is decoded from a file, and generated from types. This commit goes back to comparing the encoded version of the spec. That works better, but requires that we don't append servers, otherwise the old spec will always have different servers. All of the other fields we set are from writeOpenAPISpec replace any existing values, so it seems appropriate to do the same for Servers.
This allows us to remove the comparison logic and simply re-generate the spec file every time. Co-Authored-By: Michael Yang <michael.yang@infrahq.com>
dnephin
force-pushed
the
dnephin/openapi-spec-date
branch
from
b7d66ce
to
deec706
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I noticed the date update problem was happening again after #1290.
Using reflect.Equal does not appear to work, there must be differences between how the spec is decoded from a file, and generated from types.
This PR replaces the the date with the product version. Thanks to @mxyng , we can set this version from the please-release github action.
Checklist
Builds on #1290