Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 165 additions & 0 deletions docs/changelog/8-68-1-Release.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This recipe is available under the [Moderne Proprietary License](https://docs.mo
| Parameter | Value |
| --- | --- |
|addMarkers|`null`|
|cvePattern||
|cvePattern|`null`|


<Tabs groupId="beforeAfter">
Expand Down
4 changes: 2 additions & 2 deletions docs/recipes/devcenter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ _Recipes that include further recipes, often including the individual recipes be
* [Parent POM upgrade](./parentpomupgrade.md)
* [Report as security issues](./reportassecurityissues.md)
* [Upgrade Apache Maven Parent](./upgrademavenparent.md)
* [Upgrade Apache Maven Parent](./upgrademavenpluginsparent.md)
* [Upgrade Apache Maven Parent](./upgrademavensharedparent.md)
* [Upgrade Apache Parent POM](./upgradeapacheparent.md)
* [Upgrade Maven Plugins Parent](./upgrademavenpluginsparent.md)
* [Upgrade Maven Shared Parent](./upgrademavensharedparent.md)
* [Upgrade Quarkus Universe BOM](./upgradequarkusuniversebom.md)
* [Vulnerabilities status](./dependencyvulnerabilitycheck.md)

Expand Down
6 changes: 3 additions & 3 deletions docs/recipes/devcenter/upgrademavenpluginsparent.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
sidebar_label: "Upgrade Apache Maven Parent"
sidebar_label: "Upgrade Maven Plugins Parent"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Upgrade Apache Maven Parent
# Upgrade Maven Plugins Parent

**io.moderne.devcenter.UpgradeMavenPluginsParent**

Expand Down Expand Up @@ -37,7 +37,7 @@ This recipe is available under the [Moderne Source Available License](https://do
---
type: specs.openrewrite.org/v1beta/recipe
name: io.moderne.devcenter.UpgradeMavenPluginsParent
displayName: Upgrade Apache Maven Parent
displayName: Upgrade Maven Plugins Parent
description: |
Upgrades the Apache Maven parent POM to the latest version.
recipeList:
Expand Down
6 changes: 3 additions & 3 deletions docs/recipes/devcenter/upgrademavensharedparent.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
sidebar_label: "Upgrade Apache Maven Parent"
sidebar_label: "Upgrade Maven Shared Parent"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Upgrade Apache Maven Parent
# Upgrade Maven Shared Parent

**io.moderne.devcenter.UpgradeMavenSharedParent**

Expand Down Expand Up @@ -37,7 +37,7 @@ This recipe is available under the [Moderne Source Available License](https://do
---
type: specs.openrewrite.org/v1beta/recipe
name: io.moderne.devcenter.UpgradeMavenSharedParent
displayName: Upgrade Apache Maven Parent
displayName: Upgrade Maven Shared Parent
description: |
Upgrades the Apache Maven parent POM to the latest version.
recipeList:
Expand Down
1 change: 1 addition & 0 deletions docs/recipes/github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ _Recipes that include further recipes, often including the individual recipes be

## Recipes

* [Add cooldown periods to Dependabot configuration](./adddependabotcooldown.md)
* [Add cron workflow trigger](./addcrontrigger.md)
* [Add manual workflow trigger](./addmanualtrigger.md)
* [Cancel in-progress workflow when it is triggered again](./autocancelinprogressworkflow.md)
Expand Down
299 changes: 299 additions & 0 deletions docs/recipes/github/adddependabotcooldown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,299 @@
---
sidebar_label: "Add cooldown periods to Dependabot configuration"
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Add cooldown periods to Dependabot configuration

**org.openrewrite.github.AddDependabotCooldown**

_Adds a `cooldown` section to each update configuration in Dependabot files. Supports `default-days`, `semver-major-days`, `semver-minor-days`, `semver-patch-days`, `include`, and `exclude` options. This implements a security best practice where dependencies are not immediately adopted upon release, allowing time for security vendors to identify potential supply chain compromises. Cooldown applies only to version updates, not security updates. [Read more about dependency cooldowns](https://blog.yossarian.net/2025/11/21/We-should-all-be-using-dependency-cooldowns). [The available configuration options for dependabot are listed on GitHub](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates)._

### Tags

* [github](/reference/recipes-by-tag#github)
* [security](/reference/recipes-by-tag#security)
* [dependabot](/reference/recipes-by-tag#dependabot)
* [dependencies](/reference/recipes-by-tag#dependencies)

## Recipe source

[GitHub](https://github.com/openrewrite/rewrite-github-actions/blob/main/src/main/java/org/openrewrite/github/AddDependabotCooldown.java),
[Issue Tracker](https://github.com/openrewrite/rewrite-github-actions/issues),
[Maven Central](https://central.sonatype.com/artifact/org.openrewrite.recipe/rewrite-github-actions/)

This recipe is available under the [Moderne Source Available License](https://docs.moderne.io/licensing/moderne-source-available-license).

## Options

| Type | Name | Description | Example |
| --- | --- | --- | --- |
| `Integer` | cooldownDays | *Optional*. The number of days to wait before considering a published dependency suitable for use (1-90). This delay allows security vendors time to identify potential compromises. Applied to all version types unless specific semver options are set. | `7` |
| `Integer` | semverMajorDays | *Optional*. The number of days to wait for major version updates (1-90). Only applies to package managers that support semantic versioning. | `14` |
| `Integer` | semverMinorDays | *Optional*. The number of days to wait for minor version updates (1-90). Only applies to package managers that support semantic versioning. | `7` |
| `Integer` | semverPatchDays | *Optional*. The number of days to wait for patch version updates (1-90). Only applies to package managers that support semantic versioning. | `3` |
| `List` | include | *Optional*. List of up to 150 dependencies to apply cooldown to. Supports wildcard patterns with `*`. If not specified, cooldown applies to all dependencies. | `lodash, react*` |
| `List` | exclude | *Optional*. List of up to 150 dependencies to exempt from cooldown. Supports wildcard patterns with `*`. Exclude list takes precedence over include list. | `critical-security-package` |

## Example

###### Parameters
| Parameter | Value |
| --- | --- |
|cooldownDays|`null`|
|semverMajorDays|`null`|
|semverMinorDays|`null`|
|semverPatchDays|`null`|
|include|`null`|
|exclude|`null`|


<Tabs groupId="beforeAfter">
<TabItem value=".github/dependabot.yml" label=".github/dependabot.yml">


###### Before
```yaml title=".github/dependabot.yml"
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily
- package-ecosystem: maven
directory: /
schedule:
interval: weekly
```

###### After
```yaml title=".github/dependabot.yml"
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: daily
cooldown:
default-days: 7
- package-ecosystem: maven
directory: /
schedule:
interval: weekly
cooldown:
default-days: 7
```

</TabItem>
<TabItem value="diff" label="Diff" >

```diff
--- .github/dependabot.yml
+++ .github/dependabot.yml
@@ -7,0 +7,2 @@
schedule:
interval: daily
+ cooldown:
+ default-days: 7
- package-ecosystem: maven
@@ -11,0 +13,2 @@
schedule:
interval: weekly
+ cooldown:
+ default-days: 7

```
</TabItem>
</Tabs>


## Usage

This recipe has no required configuration options. It can be activated by adding a dependency on `org.openrewrite.recipe:rewrite-github-actions` in your build file or by running a shell command (in which case no build changes are needed):
<Tabs groupId="projectType">
<TabItem value="gradle" label="Gradle">

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

```groovy title="build.gradle"
plugins {
id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
activeRecipe("org.openrewrite.github.AddDependabotCooldown")
setExportDatatables(true)
}

repositories {
mavenCentral()
}

dependencies {
rewrite("org.openrewrite.recipe:rewrite-github-actions:{{VERSION_ORG_OPENREWRITE_RECIPE_REWRITE_GITHUB_ACTIONS}}")
}
```

2. Run `gradle rewriteRun` to run the recipe.
</TabItem>

<TabItem value="gradle-init-script" label="Gradle init script">

1. Create a file named `init.gradle` in the root of your project.

```groovy title="init.gradle"
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:{{VERSION_REWRITE_GRADLE_PLUGIN}}") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-github-actions:{{VERSION_ORG_OPENREWRITE_RECIPE_REWRITE_GITHUB_ACTIONS}}")
}
rewrite {
activeRecipe("org.openrewrite.github.AddDependabotCooldown")
setExportDatatables(true)
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
```

2. Run the recipe.

```shell title="shell"
gradle --init-script init.gradle rewriteRun
```

</TabItem>
<TabItem value="maven" label="Maven POM">

1. Add the following to your `pom.xml` file:

```xml title="pom.xml"
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>{{VERSION_REWRITE_MAVEN_PLUGIN}}</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>org.openrewrite.github.AddDependabotCooldown</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-github-actions</artifactId>
<version>{{VERSION_ORG_OPENREWRITE_RECIPE_REWRITE_GITHUB_ACTIONS}}</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
```

2. Run `mvn rewrite:run` to run the recipe.
</TabItem>

<TabItem value="maven-command-line" label="Maven Command Line">
You will need to have [Maven](https://maven.apache.org/download.cgi) installed on your machine before you can run the following command.

```shell title="shell"
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-github-actions:RELEASE -Drewrite.activeRecipes=org.openrewrite.github.AddDependabotCooldown -Drewrite.exportDatatables=true
```
</TabItem>
<TabItem value="moderne-cli" label="Moderne CLI">

You will need to have configured the [Moderne CLI](https://docs.moderne.io/user-documentation/moderne-cli/getting-started/cli-intro) on your machine before you can run the following command.

```shell title="shell"
mod run . --recipe AddDependabotCooldown
```

If the recipe is not available locally, then you can install it using:
```shell
mod config recipes jar install org.openrewrite.recipe:rewrite-github-actions:{{VERSION_ORG_OPENREWRITE_RECIPE_REWRITE_GITHUB_ACTIONS}}
```
</TabItem>
</Tabs>

## See how this recipe works across multiple open-source repositories

import RecipeCallout from '@site/src/components/ModerneLink';

<RecipeCallout link="https://app.moderne.io/recipes/org.openrewrite.github.AddDependabotCooldown" />

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

Please [contact Moderne](https://moderne.io/product) for more information about safely running the recipes on your own codebase in a private SaaS.
## Data Tables

<Tabs groupId="data-tables">
<TabItem value="org.openrewrite.table.SourcesFileResults" label="SourcesFileResults">

### Source files that had results
**org.openrewrite.table.SourcesFileResults**

_Source files that were modified by the recipe run._

| Column Name | Description |
| ----------- | ----------- |
| Source path before the run | The source path of the file before the run. `null` when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |

</TabItem>

<TabItem value="org.openrewrite.table.SourcesFileErrors" label="SourcesFileErrors">

### Source files that errored on a recipe
**org.openrewrite.table.SourcesFileErrors**

_The details of all errors produced by a recipe run._

| Column Name | Description |
| ----------- | ----------- |
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |

</TabItem>

<TabItem value="org.openrewrite.table.RecipeRunStats" label="RecipeRunStats">

### Recipe performance
**org.openrewrite.table.RecipeRunStats**

_Statistics used in analyzing the performance of recipes._

| Column Name | Description |
| ----------- | ----------- |
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time (ns) | The total time spent across the scanning phase of this recipe. |
| Max scanning time (ns) | The max time scanning any one source file. |
| Cumulative edit time (ns) | The total time spent across the editing phase of this recipe. |
| Max edit time (ns) | The max time editing any one source file. |

</TabItem>

</Tabs>
1 change: 1 addition & 0 deletions docs/recipes/gradle/changedependencygroupid.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ This recipe is available under the [Apache License Version 2.0](https://www.apac

This recipe is used as part of the following composite recipes:

* [Migrate to JasperReports 5.6.x](/recipes/jasperreports/upgradetojasperreports5.md)
* [Update the Micronaut Session support](/recipes/java/micronaut/updatemicronautsession.md)

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/recipes/gradle/plugins/upgradepluginversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This recipe is used as part of the following composite recipes:
* [Migrate to Spring Boot 3.4 (Community Edition)](/recipes/java/spring/boot3/upgradespringboot_3_4-community-edition.md)
* [Migrate to Spring Boot 3.5 (Community Edition)](/recipes/java/spring/boot3/upgradespringboot_3_5-community-edition.md)
* [Migrate to Spring Boot 3.5 (Moderne Edition)](/recipes/java/spring/boot3/upgradespringboot_3_5-moderne-edition.md)
* [Migrate to Spring Boot 4.0 (Moderne Edition)](/recipes/java/spring/boot4/upgradespringboot_4_0-moderne-edition.md)
* [Migrate to Spring Boot 4.0 (Community Edition)](/recipes/java/spring/boot4/upgradespringboot_4_0-community-edition.md)
* [Upgrade to Spring Boot 2.5](/recipes/java/spring/boot2/upgradespringboot_2_5.md)

## Examples
Expand Down
Loading
Loading