@datadog/create-apps 0.1.2 → 0.2.0

package/README.md

@@ -10,7 +10,7 @@ npm init @datadog/apps
 yarn init @datadog/apps
 ```
 
-Follow the interactive prompts to:
+Choose a standalone app or monorepo. The standalone path then keeps the existing prompts:
 
 1. Enter your app name (human-readable, e.g. "My Awesome App")
 2. Enter a directory name (slugified default from the app name, e.g. "my-awesome-app")
@@ -50,7 +50,7 @@ Skip the template prompt and use the named template (e.g. `vite-react`).
 
 ### `--yes`, `-y`
 
-Accept all defaults without prompting. Requires a directory to be provided as a positional argument.
+Accept all defaults without prompting. Requires a directory to be provided as a positional argument. New monorepos also require `--app-directory`.
 
 ### `--overwrite`
 
@@ -58,12 +58,63 @@ Overwrite an existing target directory without prompting. Required to replace an
 
 ### `--skip-post-scaffold`
 
-Skip automatic setup commands (dependency installation, git initialization, etc.).
+Skip automatic setup commands (dependency installation, git initialization, etc.) for standalone apps. Workspace setup and lockfile validation cannot be skipped.
 
 ### `--validate`
 
 Validate the bundled templates and exit. Intended for CI / development of this CLI.
 
+## Monorepos
+
+Use the development release to create an npm workspace and its first Datadog App:
+
+```bash
+npm create @datadog/apps@dev -- my-workspace --monorepo \
+  --app-directory first-app --name "First App" --site datadoghq.com
+```
+
+The workspace keeps apps under `apps/*`, shared packages under `packages/*`, shared TypeScript and ESLint configuration at the root, and one root `package-lock.json`. The root `package.json` records only the workspace layout (`datadogApps.container`); every app's site, identifier, and name stay in its own `datadog-app.config.json`.
+
+When the command detects an existing generated workspace, it adds the requested app to that workspace instead of creating a nested repository:
+
+```bash
+npm create @datadog/apps@dev -- another-app --name "Another App"
+```
+
+Each app declares its own site. Interactive app creation prompts for it when `--site` is omitted; non-interactive creation uses `datadoghq.com` unless `--site` is passed.
+
+Create a shared package from inside the workspace with:
+
+```bash
+npm create @datadog/apps@dev -- --package shared-utils
+```
+
+### `--monorepo`
+
+Create a new npm workspace and scaffold its first app. Without `--yes`, the initial prompt also offers this mode.
+
+### `--app-directory <directory>`
+
+Set the first app's directory when creating a monorepo. `--name` remains the app's user-facing name.
+
+### `--container <directory>`
+
+Change the generated workspace's apps container from the default `apps` directory. Nested containers use `/` separators on every platform.
+
+### `--package <name>`
+
+Add a shared package under `packages/<name>` in a detected workspace.
+
+### `--github-repo <owner/repository>`
+
+For a new monorepo, create a private GitHub repository with `gh`, set it as `origin`, and push the initial commit. Standalone creation remains unchanged and does not accept this option.
+
+### `--set-secrets`
+
+Set or update `DATADOG_API_KEY` and `DATADOG_APP_KEY` on an existing workspace repository. The repository is read from `--github-repo` or the current `origin` remote.
+
+New monorepos include `.github/workflows/validate-datadog-apps.yml` for unconditional pull-request checks and `.github/workflows/deploy-datadog-apps.yml` for path-filtered default-branch uploads. Both execute `.github/scripts/validate-workspace.mjs` for React dependency alignment. The deployment workflow detects affected apps and runs the root-installed `datadog-apps upload` command from each selected app directory, with each app's own site and the Git commit as its version name, without requiring an app-owned `upload` script. The repository variable `DD_SITE` overrides every app's site when set.
+
 ## What Gets Created
 
 The CLI will: