Add cron workflow trigger
** org.openrewrite.github.AddCronTrigger** _The schedule _ event allows you to trigger a workflow at a scheduled time.

Source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-github-actions
  • version: 1.5.0

Options

Type
Name
Description
String
cron

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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.AddCronTriggerExample
4
displayName: Add cron workflow trigger example
5
recipeList:
6
- org.openrewrite.github.AddCronTrigger:
7
cron: 0 18 * * *
Copied!
Now that com.yourorg.AddCronTriggerExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-github-actions:1.5.0 in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.20.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.AddCronTriggerExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
12
13
dependencies {
14
rewrite("org.openrewrite.recipe:rewrite-github-actions:1.5.0")
15
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.23.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.AddCronTriggerExample</recipe>
11
</activeRecipes>
12
</configuration>
13
<dependencies>
14
<dependency>
15
<groupId>org.openrewrite.recipe</groupId>
16
<artifactId>rewrite-github-actions</artifactId>
17
<version>1.5.0</version>
18
</dependency>
19
</dependencies>
20
</plugin>
21
</plugins>
22
</build>
23
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipes=com.yourorg.AddCronTriggerExample

Definition

Recipe List
Yaml Recipe List
    • key: $.on
    • yaml: `schedule:
    • cron: "0 18 * * *"`
    • acceptTheirs: true
    • fileMatcher: .github/workflows/*.yml
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: org.openrewrite.github.AddCronTrigger
4
displayName: Add cron workflow trigger
5
description: The `schedule` [event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events) allows you to trigger a workflow at a scheduled time.
6
7
recipeList:
8
- org.openrewrite.yaml.MergeYaml:
9
key: $.on
10
yaml: schedule:
11
- cron: "0 18 * * *"
12
acceptTheirs: true
13
fileMatcher: .github/workflows/*.yml
Copied!
Export as PDF
Copy link