Green-Software-Foundation / if

Impact Framework
https://if.greensoftware.foundation/
MIT License
143 stars 40 forks source link

Fix problem with commit lint #757

Closed zanete closed 2 months ago

zanete commented 4 months ago

What

There is an intermittent problem with the commitlint configuration that has been reported by @pazbardanl @jmcook1186 and @manushak but does not yet have a diagnosis. It needs diagnoising and fixing to ensure we maintain a good developer experience.

Why As a developer I want to be able to raise PRs into IF without having to fiddle with commitlint config as it degrdaes the DX.

Context

When developing locally, there are cases where npm test reports 100% passing tests and npm run fix reports no issues, however, when pushing a commit, commitlint errors out due to failing tests. Removing npm test from the commitlint config solves the issue, suggesting that there is some difference between the true state of the local environment and the one commitlint is using to run its tests.

SoW

Acceptance criteria

zanete commented 4 months ago

@jmcook1186 please report the issue that you have experienced when you can't push your commits

narekhovhannisyan commented 4 months ago

@jmcook1186 do you know any steps to reproduce this?

jmcook1186 commented 4 months ago

I'm not sure, I'm afraid, it occurs frequently but I haven't yet noticed what the pattern is. At some point during development commits just stop passing commitlint due to test failures. Speculate that maybe it happens after a git pull when there are staged local changes, but not sure that this is true.

zanete commented 3 months ago

@manushak @jmcook1186 please add any context you can when you experience this issue as it is currently not possible for @narekhovhannisyan to replicate

jmcook1186 commented 3 months ago

@manushak and @narekhovhannisyan to have sync to identify cause

jmcook1186 commented 2 months ago

Closing as it seems to have fixed itself in the interim...!