Add cron workflow trigger

org.openrewrite.github.AddCronTrigger

The schedule event allows you to trigger a workflow at a scheduled time.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-github-actions

  • version: 2.1.7

Options

TypeNameDescriptionExample

String

cron

Using the POSIX cron syntax or the non standard options @hourly @daily @weekly @weekdays @weekends @monthly @yearly.

@daily

String

workflowFileMatcher

Optional. Matches one or more workflows to update. Defaults to *.yml

build.yml

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddCronTriggerExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddCronTriggerExample
displayName: Add cron workflow trigger example
recipeList:
  - org.openrewrite.github.AddCronTrigger:
      cron: '@daily'
      workflowFileMatcher: build.yml

Now that com.yourorg.AddCronTriggerExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-github-actions:2.1.7 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.10.0")
}

rewrite {
    activeRecipe("com.yourorg.AddCronTriggerExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-github-actions:2.1.7")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Last updated