-
Notifications
You must be signed in to change notification settings - Fork 14
CLOUDP 329998: IPA package configuration #846
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
tools/spectral/ipa/README.md
Outdated
| Installation & Usage | [IPA README](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa#readme) | | ||
| Implemented Rules | [Ruleset Documentation](https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/rulesets#readme) | | ||
| Spectral Docs | [Spectral](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview) | | ||
| Spectral Wiki (Internal) | [http://go/openapi-spectral-updates](http://go/openapi-spectral-updates) | |
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.
This link is more relevant for the legacy spectral rule, can you move the link there?
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.
Or remove it. We can avoid go links as feedback I got is that they are not consistently adopted.
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.
@wtrocki Lovisa and I discussed the legacy spectral ruleset a bit last week, I made a follow up ticket CLOUDP-334400 to clarify the difference between the two. Ideally we have a separate subdirectory next to the IPA one that contains the legacy rules
To confirm: packed version were used in ruleset and it functions correctly? Challenge of testing is that locally checked out package will have all dependencies installed from root. |
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. Awesome change and work on separation of concerns.
I strongly suggest avoiding 1.0.0 initially. Otherwise, no blockers.
To confirm. I did tested this locally and package works as standalone bundle! |
day: tuesday | ||
commit-message: | ||
prefix: "chore" | ||
- package-ecosystem: npm |
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.
Important: Set one of the package version -1 . post merge we can validate dependabot updates.
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.
When should I do this? Now or post merge?
Co-authored-by: Wojciech Trocki <[email protected]>
Co-authored-by: Lovisa Berggren <[email protected]>
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! Thanks for the changes 🚀
Proposed changes
IPA Validation Framework package has not been released yet
Configure package.json for IPA Validation Framework npm package. The package only exports the ipa-spectral.yaml ruleset for use in other projects so scripts and dev dependencies are not included. Dependabot will update the IPA dependencies alongside the root package. This configuration has been tested locally using
npm pack
.Upcoming PRs on this ticket:
Jira ticket: CLOUDP-329998