-
Notifications
You must be signed in to change notification settings - Fork 14
CLOUDP-301106: Move preview specs to preview folder #433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
3d4c487 to
68aed82
Compare
.github/scripts/split_spec.sh
Outdated
| mv -f "openapi-foas.yaml" "./openapi/v2.yaml" | ||
|
|
||
| echo "Moving preview files to preview folder" | ||
| find ./openapi/v2 -type f -name "*preview*" -exec mv -f {} ./openapi/preview/ \; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should move only private preview specs into private-preview folder and keep the public preview spec (it should be only 1 spec) with the stable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
works for me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about versions, where should we store them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean by versions? Do you mean the versions.json file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, as of now I was adding the list of preview versions into the preview folder, but the command will return both private and public
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it makes sense to have the openapi/v2/versions.json containing the public preview and openapi/v2/private-preview/versions.json with only the private preview versions. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmmm can be, should we then leave the preview under v2 maybe?
| set -eou pipefail | ||
|
|
||
| echo "Running FOAS CLI versions command" | ||
| foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that the PR has the .keep file. We should remove them and add .keep in the gitignore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if i add it i can't keep the file, would like to keep it to avoid trying to create the folder during ci/cd
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you can add a version.json file instead of the .keep. The file will be overriden in the next action run
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
much better, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Proposed changes
Jira ticket: CLOUDP-301106
Closes #[issue number]
Checklist
Changes to Spectral
Further comments