Problem/Motivation
The last pipeline for the current development branch 3.x reported quite a few errors for the job CSPELL, see:
- Pipeline: https://git.drupalcode.org/issue/admin_toolbar-3407845/-/pipelines/226057
- Job: https://git.drupalcode.org/issue/admin_toolbar-3407845/-/jobs/2137356
Steps to reproduce
Build > Pipeline > Run pipeline :
https://git.drupalcode.org/project/admin_toolbar/-/pipelines
Select branch: 3.x
Proposed resolution
Fix all errors reported by CSPELL:
- Fix all spelling, typos and other types of errors, based on suggestions.
- Ignore certain keywords or names.
Feel free to let us know if you have any questions or concerns on any aspects of this ticket or the project in general, we would be glad to help.
Thanks in advance!
Issue fork admin_toolbar-3463378
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
Comments
Comment #3
dydave commentedQuick follow-up on this issue:
Changes from MR!68 were ported to this ticket's merge request MR!86, from related issue #3407845: GitlabCI support: Add config file and fix PHPUnit tests.
Fixed all cspell validation errors based on report and required job to pass.
Last pipeline with cspell job completing successfully:
Important note:
The usernames could potentially be ignored by default if the
Maintainerssections of eachREADME.mdfiles could be moved toMAINTAINERS.txtfiles, the same way it has been done here:https://git.drupalcode.org/project/token/-/merge_requests/76/diffs#diff-...
But since the formatting is currently using markdown (
.mdfiles), we thought it would be better to stick with what we currently have and perhaps consider in a future issue movingMaintainerssections to specificMAINTAINERS.mdfiles.(Not sure if the format is already supported and recommended for contributed modules)
The up side of using
MAINTAINERSfiles is that we wouldn't have to maintain these user names in an additional file, see:https://git.drupalcode.org/project/admin_toolbar/-/merge_requests/86/dif...
We would greatly appreciate if a maintainer or someone with write permission could take a look at ticket's merge request MR!86 and let us know if there would be any more work needed.
Feel free to let us know if you have any questions or concerns on any of the changes in the merge request or any aspect of this ticket in general, we would surely be glad to help.
Thanks in advance for your feedback and reviews.
Comment #4
dydave commentedComment #5
ankitv18 commentedMarking this RTBC considering the cspell pipeline is fixed: https://git.drupalcode.org/issue/admin_toolbar-3463378/-/jobs/2207580
And also great to see configured cspell to fail the pipeline if any mistake is there.
Comment #6
rajeshreeputraChanges looks good, CI passing, can we get it merged? this will unblock the Drupal 11 compatibility issue - #3363604: Add Drupal 11 support.
Thanks!
Comment #7
dydave commentedRebased MR!86 on 3.x with gitlabci tests and required cspell job to pass.
✅ Merge request seems to complete successfully with all CSpell validation errors fixed, see:
Back to Needs review for more reviews, testing and feedback.
Thanks!
Comment #10
japerryPersonally, I'm not a fan of cspell. However, I will commit this since it is green. Not going to make it a failing test though.