Adding Description heading for Actions

[mw-root]

Description

This PR adds code to pull the description field for actions and add it to the docs if defined.

I am not a great go dev, so I have tried to keep these changes in line with the existing code base.

[github-actions]

Thanks for implementing a fix, could you ensure that the test covers your changes if applicable.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (7ccc464) 91.53% compared to head (84142c7) 91.53%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #510   +/-   ##
=======================================
  Coverage   91.53%   91.53%           
=======================================
  Files           1        1           
  Lines         130      130           
=======================================
  Hits          119      119           
  Misses          8        8           
  Partials        3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jackton1]

Hi, @mw-root If you're curious you can add a new test to this file cmd/root_test.go.

[jackton1]

@all-contributors please add @mw-root for code and docs

[allcontributors]

@jackton1

I've put up a pull request to add @mw-root! 🎉

[github-advanced-security]

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

[mw-root]

Hi, @mw-root If you're curious you can add a new test to this file cmd/root_test.go.

Hi @jackton1 , I added description markers to a couple MD files in test.
These tests all seem to hinge on whether or not the tool ran successfully, so I figured adding desc tags would cover that. Did you want another run with something specific for the action description?

[github-advanced-security]

Markdownlint (reported by Codacy) found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

[jackton1]

Hi, @mw-root If you're curious you can add a new test to this file cmd/root_test.go.

Hi @jackton1 , I added description markers to a couple MD files in test. These tests all seem to hinge on whether or not the tool ran successfully, so I figured adding desc tags would cover that. Did you want another run with something specific for the action description?

That was all good. I made some minor edits after testing it everything worked as expected.