Documentation

[kj4ezj]

This pull request adds documentation explaining how to integrate this GitHub Action with a GitHub App in your organization in order to clone private submodules, as well as documentation on the release process for cutting new versions of this action.

prettier

I also disabled prettier for markdown documents. It failed on my first documentation change with no useful feedback as to why. I looked into installing it locally to comply with your linter rules, but the prettier documentation explicitly warns it requires configuration in order to play nicely with eslint, a tool I rely on heavily for work, and I just don't have time to fight with it. I am sorry to submit a PR that does not follow your project's formatting guidelines. I hope you find the additional documentation valuable enough to accept it as-is or to help me by formatting the markdown to comply with your static analysis tool, but I understand if you do not. Thank you for your GitHub Action!

See Also

• AntelopeIO/github-app-token-action pull request 3

[tibdex]

Hi, thanks for the work but I don't think this action requires extra documentation:

• Your use case of cloning private submodules is nice but it's not the only situation where this action is useful. I don't want to set a precedent that would open the door to an endless list of examples which would be a burden to maintain.
• The details about how https://github.com/DylanVann/publish-github-action works are and should be in that repo and not in actions relying on it.