Skip to content

Commit b1ff12a

Browse files
CLOUDP-278403: Update README and template & link to wiki
1 parent 41f4720 commit b1ff12a

File tree

2 files changed

+4
-28
lines changed

2 files changed

+4
-28
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/README.md

Lines changed: 1 addition & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,10 @@
22

33
If adding new rules or updating `.spectral.yaml` overall, the validations will instantly get updated across the `mongodb/openapi` repository.
44

5-
To propagate the changes in MMS, engineers must open an MMS PR and update the pinned commit SHA for the imported spectral file from `mongodb/openapi`.
6-
7-
## Scenarios
8-
9-
There are two scenarios depending on the changes you are making to `.spectral.yaml` and whether it affects the currently published OAS or not.
10-
11-
### Scenario 1: The current OAS doesn't violate the new linting
12-
135
Please perform the following steps:
146

157
1. Open a `mongodb/openapi` PR with the changes to `tools/spectral/.spectral.yaml`
168
2. Validate that the new Spectral lint checks pass
179
3. Review and merge the PR
18-
4. Open a PR in MMS, updating the commit SHA of the imported spectral file
19-
5. Validate all tests pass
20-
6. Review and merge the MMS PR
21-
22-
### Scenario 2: The current OAS violates the new linting
23-
24-
There are cases when updating the MMS OAS and the `.spectral.yaml` in `mongodb/openapi` that will cause the spectral linting to fail, because the current published OAS violates the new spectral rules. Changes in the MMS OAS will not be reflected until the next release. In this case please perform the following steps:
25-
26-
1. Open a PR in MMS with the OAS changes and updating the MMS `.spectral.yaml` with the new/changed rules
27-
2. If the current `mongodb/openapi` spectral rules will violate the OAS changes, open a PR in `mongodb/openapi` and update/disable any rules that will fail
28-
3. Validate that the Spectral lint passes in `mongodb/openapi` and in MMS
29-
4. Review and merge both PRs
30-
5. Wait for the next release when the published OAS is updated
31-
6. Open a `mongodb/openapi` PR updating the linting `spectral-lint.yaml` with the linting changes initially added to MMS
32-
7. Validate that all tests pass
33-
8. Review and merge the PR
34-
9. Open a PR in MMS, updating the commit SHA of the imported spectral file, and removing any rules that were added to `mongodb/openapi`
35-
10. Validate all tests pass
36-
11. Review and merge the MMS PR
3710

38-
The end goal is for the `.spectral.yaml` in `mongodb/openapi` to contain all rules for the linting. The published OASes in each environment should comply with those rules.
11+
**Note:** For MongoDB engineers, please review http://go/openapi-spectral-updates.

0 commit comments

Comments
 (0)