All Projects FreeCAD  Addon Manager  Arch  Assembly  Draft  Expressions  FEM  File formats  GCS  OpenSCAD  Part  PartDesign  Path  Project Tools & Websites  Raytracing  Robot  Sketcher  Spreadsheet  TechDraw

View Issue Details

Jump to NotesJump to History
IDProjectCategoryView StatusDate SubmittedLast Update
0003205Project Tools & WebsitesGeneralpublic2017-10-01 12:242022-01-23 00:13
ReporterKunda1 Assigned To 
PrioritylowSeverityfeatureReproducibilityN/A
Status closedResolutionfixed 
Target Version0.20Fixed in Version0.20 
Summary0003205: TravisCI to check spelling of submitted Pull Requests to FC repo
DescriptionBased on this tutorial we could use codespell to run spelling checks on submitted PRs to travis. This test won't stop builds from building but should notify the user via the PR notes which typos were found.

Currently testing is done manually via:
codespell -d -q 3 --skip="*.po,*.ts,./.git,./src/3rdParty,./src/zipios++,./src/CXX" --ignore-words=../fc-word-whitelist.txt

Somethings to resolve technically:
  • How to install codespell via travisci (apt-get I assume)?
  • Skip non-relevant 3rd party directories src/CXX src/zipios++ src/3rdParty [DONE]
  • Whitelist certain words: [DONE] see https://gist.github.com/luzpaz/7ac1bf4412b9c1e5acde715ef9cb612c
  • Make sure the test doesn't fail the build but just informs user via the PR tracker note.
Additional InformationUpstream codespell ticket: https://github.com/lucasdemarchi/codespell/issues/139
TagsTravisCI, unit-test
FreeCAD Information

Relationships

related to 0003206 assignedKunda1 TravisCI to run code linting to report trailing whitespace/tabs + LF line endings 
child of 0003259 closed Buildbot framework 

Activities

Kunda1

2017-10-01 14:27

administrator   ~0010227

According to one of the upstream codespell devs:


We use it here:

https://github.com/mne-tools/mne-python/blob/master/.travis.yml#L173

And the Makefile (make codespell for interactive mode and make codespell-error for CI):

https://github.com/mne-tools/mne-python/blob/master/Makefile#L99

larsoner

Kunda1

2017-10-14 16:08

administrator   ~0010296

submitted test PR in FreeCAD Pull Request 1039

Kunda1

2017-10-16 18:54

administrator   ~0010303

Problem, need to abandon the api token methodology and use webhooks. See https://github.com/FreeCAD/FreeCAD/pull/1039#issuecomment-336982942

chennes

2021-12-17 03:53

administrator   ~0016108

This is probably obsolete now: we could consider using GitHub actions.

Kunda1

2022-01-23 00:13

administrator   ~0016250

Thanks to Floriansimmer we have a codespell github action
https://github.com/FreeCAD/FreeCAD/commit/c7cf9b25dfc6ec4fbbba8db7adfd7eb54be105fa

Issue History

Date Modified Username Field Change
2017-10-01 12:24 Kunda1 New Issue
2017-10-01 12:24 Kunda1 Tag Attached: unit-test
2017-10-01 12:24 Kunda1 Tag Attached: TravisCI
2017-10-01 14:25 Kunda1 Additional Information Updated
2017-10-01 14:27 Kunda1 Note Added: 0010227
2017-10-01 20:11 Kunda1 Relationship added related to 0003206
2017-10-01 20:39 Kunda1 Status new => assigned
2017-10-01 20:39 Kunda1 Assigned To => Kunda1
2017-10-13 09:45 Kunda1 Description Updated
2017-10-14 16:08 Kunda1 Note Added: 0010296
2017-10-16 18:54 Kunda1 Note Added: 0010303
2017-11-12 17:26 Kunda1 Relationship added child of 0003259
2021-02-06 06:36 abdullah Target Version => 0.20
2021-12-17 03:53 chennes Note Added: 0016108
2022-01-23 00:13 Kunda1 Assigned To Kunda1 =>
2022-01-23 00:13 Kunda1 Status assigned => closed
2022-01-23 00:13 Kunda1 Resolution open => fixed
2022-01-23 00:13 Kunda1 Fixed in Version => 0.20
2022-01-23 00:13 Kunda1 Note Added: 0016250