Skip to content

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Feb 20, 2025
Merged

CLOUDP-301106: Move preview specs to preview folder #433

Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
68aed82
CLOUDP-301106: Move preview specs to preview folder
blva Feb 20, 2025
420bf00
Update
blva Feb 20, 2025
b2da64e
Add folders
blva Feb 20, 2025
46b117d
update
blva Feb 20, 2025
1dc8baa
update
blva Feb 20, 2025
3dad32a
update git ignore
blva Feb 20, 2025
f84b446
move only private-preview files
blva Feb 20, 2025
aacdf75
Update
blva Feb 20, 2025
fa367b8
update
blva Feb 20, 2025
17dfcf5
update
blva Feb 20, 2025
5e7e594
update
blva Feb 20, 2025
1deba60
uuse empty versions file
blva Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/scripts/split_spec.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
set -eou pipefail

echo "Running FOAS CLI versions command"
foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}"
Copy link
Collaborator

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

Copy link
Collaborator Author

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

Copy link
Collaborator

@andreaangiolillo andreaangiolillo Feb 20, 2025 •
edited
Loading

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

much better, thanks!

foascli versions -s openapi-foas.json -o ./openapi/v2/versions.json --env "${target_env:?}" --stability-level stable

echo "Running FOAS CLI versions command for preview"
foascli versions -s openapi-foas.json -o ./openapi/preview/versions.json --env "${target_env:?}" --stability-level preview

echo "Running FOAS CLI split command with the following --env=${target_env:?} and -o=./openapi/v2/openapi.json"

Expand All @@ -11,3 +14,6 @@ mv -f "openapi-foas.json" "./openapi/v2.json"

foascli split -s openapi-foas.yaml --env "${target_env:?}" -o ./openapi/v2/openapi.yaml
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/ \;
Copy link
Collaborator

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works for me!

Copy link
Collaborator Author

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?

Copy link
Collaborator

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?

Copy link
Collaborator Author

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

Copy link
Collaborator

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?

Copy link
Collaborator Author

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?

Loading