Skip to content
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

build: Initial spell check setup #4836

Closed
wants to merge 1 commit into from

Conversation

nschonni
Copy link
Contributor

@nschonni nschonni commented Dec 8, 2018

Initial setup for #4793. There is still some pending typo PRs that should remove some of the failures. Not sure I caught all the dictionary exclusions yet.
When this is actually consistently clean, it could be removed from the allowed_failures section

@openapi-portal-comment
Copy link

If you're a MSFT employee, click this link
to view this PR's validation status on our new OpenAPI Hub spec management tool.

@AutorestCI
Copy link

AutorestCI commented Dec 8, 2018

Automation for azure-sdk-for-python

Unable to detect any generation context from this PR.

@AutorestCI
Copy link

AutorestCI commented Dec 8, 2018

Automation for azure-sdk-for-node

Unable to detect any generation context from this PR.

@AutorestCI
Copy link

AutorestCI commented Dec 8, 2018

Automation for azure-sdk-for-ruby

Unable to detect any generation context from this PR.

@AutorestCI
Copy link

AutorestCI commented Dec 8, 2018

Automation for azure-sdk-for-js

Unable to detect any generation context from this PR.

@AutorestCI
Copy link

AutorestCI commented Dec 8, 2018

Automation for azure-sdk-for-go

Unable to detect any generation context from this PR.

@AutorestCI
Copy link

AutorestCI commented Dec 8, 2018

Automation for azure-sdk-for-java

Unable to detect any generation context from this PR.

@nschonni nschonni force-pushed the travis-spellcheck branch 2 times, most recently from e84314a to 1c69e67 Compare December 8, 2018 22:25
@azuresdkci azuresdkci requested a review from jianghaolu December 8, 2018 22:34
@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@nschonni nschonni force-pushed the travis-spellcheck branch 2 times, most recently from 9960515 to 56b5c38 Compare December 9, 2018 00:06
@nschonni
Copy link
Contributor Author

nschonni commented Dec 9, 2018

Added a few overrides for #4761 and #4670 that got closed as "wont-fix"

@jianghaolu
Copy link
Contributor

@nschonni Thanks for setting up this! Can you also provide an example of suppression?

"java",
"csharp"
],
"overrides": [
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jianghaolu these would be examples of suppression. I tried the nested config files, but these seemed to work better.

Copy link
Contributor

Choose a reason for hiding this comment

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

So I assume there isn't a way to do it in individual spec folders. Let me bring this to the team.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It takes a glob/regex, so you could relace it with somefolder/** to apply the overrides to a folder

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These examples I did at the file level with the assumption that these typos are breaking changes to fix in the current version, but you'd want it flagged in the next version so it would be fixed there

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I was actually asking if we can move this section to a separate cSpell.partial.json in somefolder/. As this list grows it may be easier to organize that way.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I believe that you can just have nested cSpell.json files, but I can't remember if I actually ran into an issue with that or that I thought it might be more confusion having other non-swagger json files mixed in

@nschonni
Copy link
Contributor Author

Rebased for a few of the PRs that landed, and added an exception for #4837

@nschonni nschonni force-pushed the travis-spellcheck branch 6 times, most recently from 5cc94ea to 566fcc1 Compare December 11, 2018 23:43
@nschonni nschonni force-pushed the travis-spellcheck branch 4 times, most recently from 76f668f to ab67f90 Compare December 17, 2018 20:57
@nschonni nschonni force-pushed the travis-spellcheck branch 4 times, most recently from 638be4d to 2034bad Compare March 5, 2019 03:03
@nschonni nschonni force-pushed the travis-spellcheck branch from 2034bad to 70e250b Compare March 13, 2019 21:15
@nschonni nschonni mentioned this pull request Mar 18, 2019
5 tasks
@nschonni nschonni force-pushed the travis-spellcheck branch 4 times, most recently from 9dd87eb to 5249c15 Compare March 26, 2019 22:26
@nschonni nschonni force-pushed the travis-spellcheck branch from 5249c15 to 74d96b6 Compare April 1, 2019 03:56
@salameer
Copy link
Member

salameer commented Apr 4, 2019

@sergey-shandar and @veronicagg thoughts here?

@nschonni nschonni force-pushed the travis-spellcheck branch from 74d96b6 to c4e4a9b Compare April 6, 2019 01:43
.travis.yml Outdated
@@ -14,13 +14,15 @@ env:
# - MODE=model PR_ONLY=false
- MODE=BreakingChange PR_ONLY=true CHECK_NAME="Breaking Changes"
- MODE=lintdiff PR_ONLY=true CHECK_NAME="Linter Diff" NODE_OPTIONS=--max-old-space-size=8192
- MODE=spellcheck CHECK_NAME="Spell Checking"
Copy link
Contributor

Choose a reason for hiding this comment

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

We are switching to Azure Dev Ops so we don't extend travis-ci

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So, undo this change, and add the step to the azure-pipelines.yml instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I switched it over to the pipelines setup, but it won't preview (AFAIK this is a default security thing)

@nschonni nschonni force-pushed the travis-spellcheck branch 2 times, most recently from c210a03 to 2f44f54 Compare April 7, 2019 05:47
@@ -127,3 +127,18 @@ jobs:
- script: echo $(NODE_OPTIONS)
- script: "scripts/swagger-to-sdk.sh Azure/$(AZURE_SDK_REPO) -v $(AZURE_SDK_PARAMS)"
displayName: "Swagger to SDK script"

- job: "Spellcheck"
condition: "not(variables['PRIVATE'])"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I copied this from the Avocado task, but maybe it should be run on your internal side too

@nschonni nschonni force-pushed the travis-spellcheck branch from 2f44f54 to 8d1269c Compare April 11, 2019 21:06
@nschonni nschonni force-pushed the travis-spellcheck branch 2 times, most recently from 16fcadd to 9b7f92a Compare April 19, 2019 18:27
@nschonni
Copy link
Contributor Author

@sergey-shandar @veronicagg I ended up suppressing all the existing issues that have PRs submitted or have open issues, so it should be "clean" to land

@nschonni nschonni force-pushed the travis-spellcheck branch from 9b7f92a to 6fd77fb Compare April 19, 2019 21:57
@nschonni nschonni force-pushed the travis-spellcheck branch from 6fd77fb to 6c4ff2d Compare April 20, 2019 02:35
@sergey-shandar
Copy link
Contributor

@nschonni we are in the process to switch to Azure DevOps. The first target is to move existing jobs. Only after that we will start accept PRs Azure DevOps pipeline.

@sergey-shandar
Copy link
Contributor

@nschonni you may want to try preproduction pipeline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants