Manorrock Parrot - a GitHub Workflow Generator

Prerequisites

1. Java 21

Cron

To set the cron schedule for a given workflow use

<!-- workflow.cron(* * * * *) -->

Direct only

To only run a snippet when it is in the original Markdown and not coming in through workflow.include use the following:

<!-- workflow.directOnly()

script commands

  -->

(Workflow) dispatch

To allow for triggering the workflow manually use the snippet below:

<!-- workflow.dispatch() -->

Include

To include content from another file one can use the following:

<!-- workflow.include(relativeFilename.md) -->

(Always) Run

To always run a specific set of comments one can use the following:

<!-- workflow.run()

script commands

  -->

Skip

To skip a snippet for inclusion use the following:

<!-- workflow.skip() -->

How do you generate GitHub workflows?

In the root directory of your GitHub repository the following invocation will generate the GitHub workflows into the .github/workflows directory.

 java -jar parrot.jar --baseDirectory . --outputDirectory .github/workflows

How do I contribute?

See Contributing

Our code of Conduct

See Code of Conduct

Important notice

Note if you file issues or answer questions on the issue tracker and/or issue pull requests you agree that those contributions will be owned by Manorrock.com and that Manorrock.com can use those contributions in any manner Manorrock.com so desires.