fix(ci,oas) move oas ci script to a package under the oas workspace

[patrick-medusajs]

What

Move OAS CI script to a package under the OAS yarn workspace.
Trigger OAS CI on all PRs

Why

Dependencies declared in the package.json at the root of the monorepo would cause unpredictable issues with yarn optimizing packages version to install.

How

• Move the all the OAS CI script and dependencies under its own package governed by the OAS yarn workspace.
• Maintain current interface, i.e.: yarn openapi:generate at the root of the repo.
• Update path resolution within the build-openapi.js script.
• Use resolutions configuration in order to instruct yarn which version should be used when resolving the dependencies for @redocly/cli

Test

Step 1

• Run yarn install
• Run yarn build
• Run yarn openapi:generate --dry-run
• Expect OAS validation to run

Step 2

• Run yarn openapi:generate
• Move to oas-github-ci package cd packages/oas/oas-github-ci
• Run yarn preview:admin
• Expect OAS preview documentation to contain latest OAS changes to admin API.

Step 3

• Run yarn preview:store
• Expect OAS preview documentation to contain latest OAS changes to store API.

[changeset-bot]

🦋 Changeset detected

Latest commit: 51b0fd6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@medusajs/medusa	Patch
@medusajs/inventory	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated
medusa-docs	⬜️ Ignored (Inspect)			Mar 6, 2023 at 9:21PM (UTC)

[shahednasser]

LGTM! Tested generating the OAS and the documentation afterwards

[kasperkristensen]

LGMT!

[olivermrbl]

question: Is there a reason for making this restricted? This setting is blocking us from publishing it in our pipeline

[patrick-medusajs]

The package is only relevant in our monorepo context. It doesn't provide any value as a standalone package. That's why I kept it as restricted. I don't think it needs to be published on npm.

[olivermrbl]

Makes sense. I think we'll have to change it to private: true. Changeset does not recognize this config when running the script to publish packages. If okay with you, I'll open a PR with it?

[patrick-medusajs]

Ah jeez, my bad for using the wrong flag in the package.json. Thanks for the PR.