JulienKode / pull-request-name-linter-action

I would like to customize the error message to provide links/references to doc as right now even I forget at times and get lost as to what needs to be done. Is there a way to customize the error message currently ?

Hi @mohanraj-r ,

Thanks for contributing ! 😊

For the moment there is no way to customize the error message because we simply show the error of commitlint

pull-request-name-linter-action/src/main.ts

Line 40 in 239b27e

const errorMessage = result.errors

What kind of api did you like to customize the message ?
Why the commitlint messages does not fits your need ? May be you want to display the commitlink error message + a link to solve the commitlint issue ? 🤔

Thanks @JulienKode
Yes an optional text (that users can supply with links to docs etc) to establish context so that what needs to be done to fix the error can be better understood. So if the text is given it should prefix the result.errors

It's sounds a pretty good idea @mohanraj-r 😊

We can close it as we do not have for now a precise idea of what we need on this feature

If anyone think it needs to be implemented feel free to re-open it 😊

Thanks @JulienKode Yes an optional text (that users can supply with links to docs etc) to establish context so that what needs to be done to fix the error can be better understood. So if the text is given it should prefix the result.errors

Agree very much! too bad there isn't a way to customize the error message.
for example the error message in https://github.com/wagoid/commitlint-github-action
is really descriptive.
eg:

Is there a way to customize the error message ?