diff --git a/docs/shared/reference/project-configuration.md b/docs/shared/reference/project-configuration.md index 83c5af40b7..bd65924cc0 100644 --- a/docs/shared/reference/project-configuration.md +++ b/docs/shared/reference/project-configuration.md @@ -650,6 +650,23 @@ In the case of an explicit target using an executor, you can specify the executo } ``` +### Target Metadata + +You can add additional metadata to be attached to a target. For example, you can provide a description stating what the +target does: + +```jsonc {% fileName="project.json" %} +{ + "targets": { + "build": { + "metadata": { + "description": "Build the application for production" + } + } + } +} +``` + ## Project Metadata The following properties describe the project as a whole. @@ -769,7 +786,21 @@ An implicit dependency could also be a glob pattern: {% /tab %} {% /tabs %} -### Including package.json files as projects in the graph +### Metadata + +You can add additional metadata to be attached to the project. For example, you can provide a description for your +project: + +```jsonc {% fileName="project.json" %} +{ + "name": "admin", + "metadata": { + "description": "This is the admin application" + } +} +``` + +## Including package.json files as projects in the graph Any `package.json` file that is referenced by the `workspaces` property in the root `package.json` file will be included as a project in the graph. If you are using Lerna, projects defined in `lerna.json` will be included. If you are using pnpm, projects defined in `pnpm-workspace.yml` will be included. diff --git a/graph/ui-project-details/src/lib/target-configuration-details/target-configuration-details.tsx b/graph/ui-project-details/src/lib/target-configuration-details/target-configuration-details.tsx index 5a8b05b629..bb99534f98 100644 --- a/graph/ui-project-details/src/lib/target-configuration-details/target-configuration-details.tsx +++ b/graph/ui-project-details/src/lib/target-configuration-details/target-configuration-details.tsx @@ -103,6 +103,25 @@ export default function TargetConfigurationDetails({ {/* body */} {!collapsed && (
+ {targetConfiguration.metadata?.description} +
+