AlexanderPrendota / kotlin-samples-pusher

GitHub Action. Tool to help validate your Kotlin documentation.

Kotlin Samples Pusher

It aims to handle snippets collection for their consistency in the repository.

Functionality

This tool can run as GitHub Action.

It can run in the two work modes:

1. Automatic mode. The action handles GitHub events such as:

   • push The tool verifies pushed commits, create PR with the new samples, creates an issue if needed.
   • pull_request The tool verifies the repository changes, creates a comment into the PR if needed.
   • shedule The tool verifies the all repository, create PR with the new samples, creates an issue.

2. Manual mode. The action runs a verification of repository. You need to unset io-event option and set the required options manually .

Options:

Name (alias)	Format	Description	Default
-push-repository (-pr)	[String]	Destination git repository to push (required)	n/a
-username	[String]	Username or access token for push to a target repository (required)	n/a
-passw	[String]	User's password for push to a target repository	empty
-push-path (p)	[String]	Path relatively a push repository	empty
-config-path	[String]	Url or file path for loading config	config.properties
-template-path	[String]	Url or file path for loading templates	templates
-severity	[String]	Create issue and do not push if the snippet has errors equals or greater the severity	ERROR

Other options is for the verifier. See https://github.com/AlexanderPrendota/kotlin-samples-verifier

Templates:

It is possible to customize the title, body of issue or pull request. Templates of issue or pull request are stored in templates/issue.md and templates/pr.md resp.

See https://freemarker.apache.org/docs/index.html