jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Move cli devcenter to how to guides

Browse Source 
Based on an internal feedback request
This commit is contained in:
Mike Solomon
2025-02-28 08:11:16 -08:00
parent c4fe7a5c08
commit 08eca68294
4 changed files with 199 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

197
docs/user-documentation/moderne-cli/getting-started/cli-dev-center.md
View File

@@ -1,196 +1,3 @@
---
sidebar_label: Generating DevCenters locally
description: How to create or edit DevCenters using the Moderne CLI.
---
import { Redirect } from '@docusaurus/router';
# Getting started with the Moderne CLI DevCenter
The Moderne DevCenter provides you with high-level details about the state of all of your repositories. Using it, you can track the progress of upgrades, migrations, and security vulnerabilities. You may be aware of [this feature in the Moderne Platform](../../moderne-platform/getting-started/dev-center.md) - but did you know that you can generate a DevCenter locally via the CLI?
In this getting started guide, we'll walk you through how to do that.
## Prerequisities
This guide assumes that you have already [installed and configured the CLI](./cli-intro.md#installation-and-configuration).
## Step 1: Checkout the repositories you want to build a DevCenter for
The first thing you'll need to do is come up with the list of repositories that you want to build a DevCenter for. Once you have that list, please ensure they are cloned to a shared directory locally. For instance, this might look like:
```bash
devcenter-demo
├── repo1
├── repo2
└── repo3
```
:::tip
You may find it useful to start by only cloning a small subset of your repositories locally so that you can test, build, and iterate quickly. Once you've confirmed everything is working as you want, you can then add more repositories as desired.
:::
We'd recommend using the [mod git clone command](../cli-reference.md#mod-git-clone) to create this shared directory. With it, you can clone repositories from a CSV file, a JSON file, or from an existing organization (if your company has set up an Organizations service).
## Step 2: Build the LSTs
With the repositories cloned, you now need to build them so that the DevCenter can be produced:
```bash
mod build devcenter-demo
```
## Step 3: Define your DevCenter
Once all of your repositories are built, it's now time to figure out what your DevCenter will look like. This is done by adding an `organization.yml` file to your `.moderne` directory that should exist inside of your shared directory:
```bash
devcenter-demo
├── .moderne
│ ├── organization.yml
├── repo1
├── repo2
└── repo3
```
This file will determine what is displayed in your DevCenter. Maybe you want to track if your repositories are you using Java 21 – or maybe you care more about security vulnerabilities.
In either case, you'll want to define those pieces inside of this `organization.yml` file.
For simplicity, we'll provide an example DevCenter file for you to copy below. However, feel free to [edit it to meet your needs](../../../administrator-documentation/moderne-dx/how-to-guides/devcenter-yaml.md)
<details>
<summary>Example `organizations.yml` file:</summary>
```yaml
name: Default
devCenterConfiguration:
version: 1
upgradesAndMigrations:
- title: Spring Boot 3
measures:
- name: Major
recipe:
id: org.openrewrite.java.dependencies.DependencyInsight
options:
- name: groupIdPattern
value: org.springframework.boot
- name: artifactIdPattern
value: spring-boot-starter
- name: version
value: 1-2.999
- name: Minor
recipe:
id: org.openrewrite.java.dependencies.DependencyInsight
options:
- name: groupIdPattern
value: org.springframework.boot
- name: artifactIdPattern
value: spring-boot-starter
- name: version
value: 3-3.2
- name: Patch
recipe:
id: org.openrewrite.java.dependencies.DependencyInsight
options:
- name: groupIdPattern
value: org.springframework.boot
- name: artifactIdPattern
value: spring-boot-starter
- name: version
value: 3.3.0
- title: Java 21
measures:
- name: Java 8+
recipe:
id: org.openrewrite.java.search.HasMinimumJavaVersion
options:
- name: version
value: 8-10
- name: Java 11+
recipe:
id: org.openrewrite.java.search.HasMinimumJavaVersion
options:
- name: version
value: 11-16
- name: Java 17+
recipe:
id: org.openrewrite.java.search.HasMinimumJavaVersion
options:
- name: version
value: 17-20
- title: JUnit 5
measures:
- name: JUnit 4
recipe:
id: org.openrewrite.java.search.FindAnnotations
options:
- name: annotationPattern
value: '@org.junit.Test'
security:
name: Security
measures:
- recipe:
id: org.openrewrite.java.security.OwaspA01
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA02
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA03
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA05
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA06
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA08
options: []
- recipe:
id: org.openrewrite.java.security.RegularExpressionDenialOfService
options: []
- recipe:
id: org.openrewrite.java.security.secrets.FindSecrets
options: []
- recipe:
id: org.openrewrite.java.security.ZipSlip
options: []
- recipe:
id: org.openrewrite.java.security.SecureTempFileCreation
options: []
```
</details>
## Step 4: Generate your DevCenter
Now that you've configured your DevCenter, you can generate it locally by running the following command inside of your shared directory:
```bash
mod devcenter run .
```
This will take a significant amount of time to run depending on the number of repositories you have and how many recipes you've defined in your DevCenter.
At the end of it, you should see something like:
```bash
> Generating DevCenter
Created DevCenter XLSX at /Users/mikesol/cli-test/./devcenter.xlsx
Created DevCenter HTML at /Users/mikesol/cli-test/./devcenter.html (2s)
MOD SUCCEEDED in (1h 3m 16s)
```
Open up the HTML file to see your DevCenter:
<figure>
![](./assets/devcenter-example.png)
<figcaption>_An example of what a locally generated DevCenter looks like_</figcaption>
</figure>
## Next steps
Once you've arrived at a DevCenter that you like, consider sharing it with your team. If you have an Organization service set up, you can even define this inside of that service so that everyone has this DevCenter by default when they `mod git clone` that organization.
<Redirect to="/user-documentation/moderne-cli/how-to-guides/cli-dev-center" />;

0
docs/user-documentation/moderne-cli/getting-started/assets/devcenter-example.png → docs/user-documentation/moderne-cli/how-to-guides/assets/devcenter-example.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 173 KiB

After

Width:  |  Height:  |  Size: 173 KiB

196
docs/user-documentation/moderne-cli/how-to-guides/cli-dev-center.md Normal file
View File

@@ -0,0 +1,196 @@
---
sidebar_label: Generating DevCenters locally
description: How to create or edit DevCenters using the Moderne CLI.
---
# How to configure the Moderne CLI DevCenter
The Moderne DevCenter provides you with high-level details about the state of all of your repositories. Using it, you can track the progress of upgrades, migrations, and security vulnerabilities. You may be aware of [this feature in the Moderne Platform](../../moderne-platform/getting-started/dev-center.md) - but did you know that you can generate a DevCenter locally via the CLI?
In this guide, we'll walk you through how to do that.
## Prerequisities
This guide assumes that you have already [installed and configured the CLI](../getting-started/cli-intro.md#installation-and-configuration).
## Step 1: Checkout the repositories you want to build a DevCenter for
The first thing you'll need to do is come up with the list of repositories that you want to build a DevCenter for. Once you have that list, please ensure they are cloned to a shared directory locally. For instance, this might look like:
```bash
devcenter-demo
├── repo1
├── repo2
└── repo3
```
:::tip
You may find it useful to start by only cloning a small subset of your repositories locally so that you can test, build, and iterate quickly. Once you've confirmed everything is working as you want, you can then add more repositories as desired.
:::
We'd recommend using the [mod git clone command](../cli-reference.md#mod-git-clone) to create this shared directory. With it, you can clone repositories from a CSV file, a JSON file, or from an existing organization (if your company has set up an Organizations service).
## Step 2: Build the LSTs
With the repositories cloned, you now need to build them so that the DevCenter can be produced:
```bash
mod build devcenter-demo
```
## Step 3: Define your DevCenter
Once all of your repositories are built, it's now time to figure out what your DevCenter will look like. This is done by adding an `organization.yml` file to your `.moderne` directory that should exist inside of your shared directory:
```bash
devcenter-demo
├── .moderne
│ ├── organization.yml
├── repo1
├── repo2
└── repo3
```
This file will determine what is displayed in your DevCenter. Maybe you want to track if your repositories are you using Java 21 – or maybe you care more about security vulnerabilities.
In either case, you'll want to define those pieces inside of this `organization.yml` file.
For simplicity, we'll provide an example DevCenter file for you to copy below. However, feel free to [edit it to meet your needs](../../../administrator-documentation/moderne-dx/how-to-guides/devcenter-yaml.md)
<details>
<summary>Example `organizations.yml` file:</summary>
```yaml
name: Default
devCenterConfiguration:
version: 1
upgradesAndMigrations:
- title: Spring Boot 3
measures:
- name: Major
recipe:
id: org.openrewrite.java.dependencies.DependencyInsight
options:
- name: groupIdPattern
value: org.springframework.boot
- name: artifactIdPattern
value: spring-boot-starter
- name: version
value: 1-2.999
- name: Minor
recipe:
id: org.openrewrite.java.dependencies.DependencyInsight
options:
- name: groupIdPattern
value: org.springframework.boot
- name: artifactIdPattern
value: spring-boot-starter
- name: version
value: 3-3.2
- name: Patch
recipe:
id: org.openrewrite.java.dependencies.DependencyInsight
options:
- name: groupIdPattern
value: org.springframework.boot
- name: artifactIdPattern
value: spring-boot-starter
- name: version
value: 3.3.0
- title: Java 21
measures:
- name: Java 8+
recipe:
id: org.openrewrite.java.search.HasMinimumJavaVersion
options:
- name: version
value: 8-10
- name: Java 11+
recipe:
id: org.openrewrite.java.search.HasMinimumJavaVersion
options:
- name: version
value: 11-16
- name: Java 17+
recipe:
id: org.openrewrite.java.search.HasMinimumJavaVersion
options:
- name: version
value: 17-20
- title: JUnit 5
measures:
- name: JUnit 4
recipe:
id: org.openrewrite.java.search.FindAnnotations
options:
- name: annotationPattern
value: '@org.junit.Test'
security:
name: Security
measures:
- recipe:
id: org.openrewrite.java.security.OwaspA01
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA02
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA03
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA05
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA06
options: []
- recipe:
id: org.openrewrite.java.security.OwaspA08
options: []
- recipe:
id: org.openrewrite.java.security.RegularExpressionDenialOfService
options: []
- recipe:
id: org.openrewrite.java.security.secrets.FindSecrets
options: []
- recipe:
id: org.openrewrite.java.security.ZipSlip
options: []
- recipe:
id: org.openrewrite.java.security.SecureTempFileCreation
options: []
```
</details>
## Step 4: Generate your DevCenter
Now that you've configured your DevCenter, you can generate it locally by running the following command inside of your shared directory:
```bash
mod devcenter run .
```
This will take a significant amount of time to run depending on the number of repositories you have and how many recipes you've defined in your DevCenter.
At the end of it, you should see something like:
```bash
> Generating DevCenter
Created DevCenter XLSX at /Users/mikesol/cli-test/./devcenter.xlsx
Created DevCenter HTML at /Users/mikesol/cli-test/./devcenter.html (2s)
MOD SUCCEEDED in (1h 3m 16s)
```
Open up the HTML file to see your DevCenter:
<figure>
![](./assets/devcenter-example.png)
<figcaption>_An example of what a locally generated DevCenter looks like_</figcaption>
</figure>
## Next steps
Once you've arrived at a DevCenter that you like, consider sharing it with your team. If you have an Organization service set up, you can even define this inside of that service so that everyone has this DevCenter by default when they `mod git clone` that organization.

2
sidebars.ts
View File

@@ -108,7 +108,6 @@ const sidebars: SidebarsConfig = {
},
items: [
'user-documentation/moderne-cli/getting-started/cli-intro',
'user-documentation/moderne-cli/getting-started/cli-dev-center',
'user-documentation/moderne-cli/getting-started/moderne-cli-license',
],
},
@@ -125,6 +124,7 @@ const sidebars: SidebarsConfig = {
items: [
'user-documentation/moderne-cli/how-to-guides/air-gapped-cli-install',
'user-documentation/moderne-cli/how-to-guides/cli-upgrade',
'user-documentation/moderne-cli/how-to-guides/cli-dev-center',
'user-documentation/moderne-cli/how-to-guides/clone-and-sync',
'user-documentation/moderne-cli/how-to-guides/parallelism',
'user-documentation/moderne-cli/how-to-guides/afterburner',