code-pushup/Code PushUp

Quality metrics from Code PushUp

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
monorepoFor repos containing multiple projects. Options are: - `false`: single project mode (default) - `true`: turns on monorepo mode (autodetects tool unless `projects` is specified) - `nx`: Nx workspace - `turbo`: Turborepo - `npm`: NPM workspaces - `yarn`: Yarn workspaces - `pnpm`: PNPM workspaces yesfalse
parallelConfigures parallel execution in monorepo mode. Possibly values are: - `false`: sequential (default) - `true`: parallel with default number of jobs (depends on monorepo tool) - integer which sets the number of concurrent jobs yesfalse
projectsProject folders for custom monorepo setup. Only used when `monorepo: true` is set and no known monorepo tool is detected. Should be a comma-separated list of project folders (supports globs). no
taskName of task for running Code PushUp CLI in monorepo mode. Defaults to `code-pushup`. Depending on what monorepo tool is being used, this task may represent a `package.json` script, binary executable, Nx target or Turbo task. yescode-pushup
nxProjectsFilterCLI arguments for `nx show projects` used to list Nx projects in monorepo mode. Replaces `{task}` with `task` input. yes--with-target={task}
binCustom code-pushup executableyesnpx --no-install code-pushup
configCustom code-pushup.config pathno
directoryCustom working directoryno
silentSilence logs from Code Pushup CLIyesfalse
tokenGITHUB_TOKEN or a repo scoped PATyes${{ github.token }}
artifactsUpload/download artifacts for caching code-pushup reportsyestrue
retentionArtifact retention period in daysno
annotationsCreate file annotations in GitHubyestrue
skipCommentSkip PR commentyesfalse
configPatternsPerformance optimization for large monorepos - `persist` and `upload` configs provided upfront to skip parsing. Replaces `{projectName}` in configured values with name of each project.no
searchCommitsIf enabled and portal cache is used, looks for previous report in target branch's 10 most recent commits (not only latest). Supports boolean or an integer (1-100), the latter overrides the default number of commits (10). yesfalse
jobIdDifferentiate PR comments (useful if multiple jobs run Code PushUp)no
namedescription
artifact-idID of uploaded report artifact
comment-idID of created or updated GitHub comment