🤖 Configlet sync: docs, metadata, and filepaths #1609
Conversation
| _ _ | ||
| |_||_ |_ | ||
There was a problem hiding this comment.
@angelikatyborska I messed up. The CI fails because of the formatting, but somehow I didn't notice it on the PR and I merged it.
The trailing white spaces are the issue here, I suppose we could:
- change the file themselves locally
- change the files upstream
- change our formatting check to ignore docs files (currently we grep for trailing whitespace on every file)
- change my brain so it doesn't mess up again
Since the white spaces are somewhat meaningful here, and it could happen that even more meaningful trailing white spaces are in future docs (there are more coming here), I'm leaning towards upgrading our format check. WDYT? I mean the last option is tempting, but I'm not sure how to act on it.
There was a problem hiding this comment.
change the file themselves locally
Not great because it will show up as changed every time we pull docs via configlet.
change the files upstream
The whitespace seems intentional, and they included a prettier ignore comment. I don't think they will want to change it.
change our formatting check to ignore docs files
I guess that would mean ignoring instructions.md and introduction.md but in practice exercises only, and not instructions.append.md ? Sounds doable.
change my brain so it doesn't mess up again
I don't have that power 😞 It looks to me like you didn't wait for the CI checks to even start running, right? It's not like you ignored a failing CI check.
My preferred solution would be completely different - change our formatting checks to be exactly the same as the docs repo has. We wouldn't need to worry about this file if our formatting check also was based on prettier 🙂
The javascript repo has this script: https://github.com/exercism/javascript/blob/main/bin/check-formatting.sh
This PR was generated automatically by a scheduled workflow.
It includes updates from
configlet syncfor:Please review and merge if everything looks good!