Skip to content

Commit

Permalink
[TASK] Add a troubleshooting and debugging section (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
gilbertsoft authored Mar 6, 2022
1 parent 7a30576 commit cd656b3
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,22 @@ jobs:
error: 'You need at least one "Resolves|Fixes: #<issue number>" line.'
```
### Troubleshooting and debugging
Most of the questions being asked here are not about bugs or missing features in
this action, but about not enough information about what is going on in the
background. A good first starting point is to [enable debug logging](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging)
for the action, which can be accomplished by adding secrets to your repository.
After that, many additional information will appear in the logs and you should
be able to set up your configuration properly.
There are some really good tools that you can use to set up your pattern
properly for your needs. My favorite tool is <https://regexr.com/> which works
very well with this action.
If you need additional support, please head to the [GitHub Discussions](https://github.com/GsActions/commit-message-checker/discussions)
of this repository.
## Development
### Quick Start
Expand Down

0 comments on commit cd656b3

Please sign in to comment.