gizumon / github-actions-documenter Goto Github PK

This is a cool action.

It would be handy if there was a way to make a few things optional to make the documentation fit into existing documents a bit better:

• Make the table of contents and links optional. I have several single workflow repositories that the extra formatting isn't needed.
• Allow the caller to specify a list of workflow yml files so if I want to document just one at a time, it's easy to do. For example, I may document a workflow per markdown file.
• Make the Generated automatically ... Please do not edit the below manually. configurable as a comment instead.

I don't do much with typescript, but I could try to hack a patch together if that would help. I'm not sure where to start for testing, though.

Github has deprecated the set-output mode of setting an output value. Instead they want us to output to an environment variable file.

I think this is the new API to call to remove the deprecation warnings:

core.exportVariable('envVar', 'Val');

Based on what I could find here:
https://github.com/actions/toolkit/blob/00282d61458d99f725588a9463b9d25dfda51c22/packages/core/README.md#exporting-variables

I'm not sure how this can happen from looking at the code, but it appears there is an extra, trailing \n line after the end of comment marker.

In successive runs, I see 2 extra lines:

• https://github.com/xmidt-org/shared-go/pull/5/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R84
• https://github.com/xmidt-org/shared-go/pull/6/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R107

• Append doc into file
• Comment PR

A workflow like this:
https://github.com/xmidt-org/shared-go/blob/d0737af7255c581ce3cc09b69b96ba16a5913b4e/.github/workflows/approve-dependabot.yml#L21

Doesn't show up in the list of workflows & the example isn't included.

It would be nice to have context highlighting since we're pretty sure the code block is going to be yaml format.

I think this is the place to add a trailing yaml to the existing ```.