paulcnova/C# Documentation Generator

This action generates a static html documentation for C# projects.

Trust Signals

name	description	required	default
build-tasks	The list of commands used to build the project prior to generating html documents.	yes	—
cleanup-tasks	The list of commands used to clean up any building of project after generating html documents.	no	—
binaries	The list of binaries used to look into, must be named the same as the xml documentation.	yes	—
user-name	The name of the user who will commit.	no	C# Document Generator
user-email	The email of the user who will commit.	no	csharp.doc.gen@gmail.com
template	The name of the template to use to generate the webpages from.	no	default
template-uris-json	The json to get all the template files used to generate the documentation.	no	—
project-details-json	The json file that contains the details of the project, used for header and footer information.	no	—
output-path	The output path of the generated documents.	no	docs/api/
branch-name	The name of the branch that the generation will commit to (if not specified it will commit to the current branch).	no	—
commit-message	The message of the commit that the generation will perform.	no	Automated creation of documentation
output-extension	The output extension that every file built will contain.	no	.html
include-private	Set to true to include all the privates types and members.	—	false
skip-git	Set to true to completely skip the git pushing process. Only set to true if the one of the next process in the action is to push to git (from another action/library).	—	false

no outputs