magma / magma

Platform for building access networks and modular network services
https://www.magmacore.org/
Other
1.67k stars 598 forks source link

CI: false positive spelling error on "optimise" reported by reviewdog #11002

Closed lucasgonze closed 2 years ago

lucasgonze commented 2 years ago

Your Environment

Describe the Issue

A CI check for spelling errors is finding an error on the word "optimise" in package names in /nms/yarn.lock. Most of the information in this file is data. It should not be checked for spelling errors.

To Reproduce

  1. Go to 'https://github.com/magma/magma/actions/runs/1565791879', titled "chore: upgrade node-forge reviewdog-workflow #4390"
  2. Scroll down to 'Annotations' ... '7 errors'
  3. See error``` [misspell] reported by reviewdog 🐶 "optimise" is a misspelling of "optimize"

Raw Output: ./nms/yarn.lock:207:19: "optimise" is a misspelling of "optimize"



**Expected behavior**
The misspelled word should not have been checked for spelling errors. It is the name of an external package.

**Screenshots**

![image](https://user-images.githubusercontent.com/111581/147502120-fd5b375e-c269-477b-8899-9cdd4817941c.png)

![image](https://user-images.githubusercontent.com/111581/147502232-bc103582-0997-4d11-a98f-d732a5a7f957.png)

**Additional context**

The tool reporting the error is reviewdog. 

It appears to be configured to flag British spellings as errors. 
stale[bot] commented 2 years ago

This pull request has been automatically marked as stale because it has not had any recent activity by the author or maintainer in the past 45 days. It will be closed if no further activity occurs in the next 7 days. Thank you for your contributions.

stale[bot] commented 2 years ago

This pull request has exceeded its lifecylce and will be closed. Should you wish to continue working on this, please reopen it or start a new pull request. Thank you again for your contributions.