Skip to content

Commit ab5e769

Browse files
CLOUDP-278403: Spectral README update for linting/OAS changes (#257)
1 parent 9a57d3a commit ab5e769

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

.github/pull_request_template.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ We're here to help! This is simply a reminder of what we are going to look for b
2323
- [ ] I have signed the [MongoDB CLA](https://www.mongodb.com/legal/contributor-agreement)
2424
- [ ] I have added tests that prove my fix is effective or that my feature works
2525

26+
### Changes to Spectral
27+
- [ ] I have read the [README](../tools/spectral/README.md) file for Spectral Updates
28+
2629
## Further comments
2730

2831
<!--

tools/spectral/.spectral.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ rules:
174174
functionOptions:
175175
match: "^(mms)$"
176176
message: "'additionalServices' must be 'mms' as no other services are supported."
177-
177+
178178
no-slash-before-custom-method:
179179
description: "Custom methods (e.g., ':applyItem') should not be preceded by a '/'."
180180
message: "The path '{{path}}' contains a '/' before a custom method. Custom methods should not start with a '/'."

tools/spectral/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Spectral updates
22

3-
If adding new rules or updating .spectral.yaml overall, the validations will instantly get updated across mongodb/openapi repository.
4-
5-
To propagate the changes in MMS, engineers must open a PR and update the pinned commit sha in mms.
3+
If adding new rules or updating `.spectral.yaml` overall, the validations will instantly get updated across the `mongodb/openapi` repository.
64

75
Please perform the following steps:
8-
1. [ ] Open a PR with the spectral changes and validate that the Spectral lint checks work.
9-
2. [ ] Review and merge the PR.
10-
3. [ ] Open a PR in mms, updating the commit sha of the spectral file imported.
11-
4. [ ] Validate all tests pass.
6+
7+
1. Open a `mongodb/openapi` PR with the changes to `tools/spectral/.spectral.yaml`
8+
2. Validate that the new Spectral lint checks pass
9+
3. Review and merge the PR
10+
11+
**Note:** For MongoDB engineers, please review http://go/openapi-spectral-updates.

0 commit comments

Comments
 (0)