Skip to content

Latest commit

 

History

History
218 lines (166 loc) · 10.3 KB

check.md

File metadata and controls

218 lines (166 loc) · 10.3 KB
Raw

flub check

Check commands are used to verify repo state, apply policy, etc.

flub check buildVersion

Checks that all packages have the same version set in package.json. The packages checked can be filtered by standard criteria. THIS COMMAND IS INTENDED FOR USE IN FLUID FRAMEWORK CI PIPELINES ONLY.

USAGE
  $ flub check buildVersion [-v | --quiet] [--version <value> | --path <value>] [--fix] [--concurrency <value>]
    [--branch <value> [--changed |  |  |  | [--all | --dir <value> | --packages | -g
    client|server|azure|build-tools|gitrest|historian|all... | --releaseGroupRoot
    client|server|azure|build-tools|gitrest|historian|all...] | ]] [--private] [--scope <value>... | --skipScope
    <value>...]

FLAGS
  --concurrency=<value>  [default: 25] The number of tasks to execute concurrently.
  --fix                  Fix invalid versions in the package.json file.
  --path=<value>         Path to a directory containing a package. The version will be loaded from the package.json in
                         this directory.
  --version=<value>      The version against which to check all the packages.

PACKAGE SELECTION FLAGS
  -g, --releaseGroup=<option>...      Run on all child packages within the specified release groups. This does not
                                      include release group root packages. To include those, use the --releaseGroupRoot
                                      argument. Cannot be used with --all, --dir, or --packages.
                                      <options: client|server|azure|build-tools|gitrest|historian|all>
      --all                           Run on all packages and release groups. Cannot be used with --dir, --packages,
                                      --releaseGroup, or --releaseGroupRoot.
      --branch=<value>                [default: main] Select only packages that have been changed when compared to this
                                      base branch. Can only be used with --changed.
      --changed                       Select only packages that have changed when compared to a base branch. Use the
                                      --branch option to specify a different base branch. Cannot be used with other
                                      options.
      --dir=<value>                   Run on the package in this directory. Cannot be used with --all, --packages,
                                      --releaseGroup, or --releaseGroupRoot.
      --packages                      Run on all independent packages in the repo. Cannot be used with --all, --dir,
                                      --releaseGroup, or --releaseGroupRoot.
      --releaseGroupRoot=<option>...  Run on the root package of the specified release groups. This does not include any
                                      child packages within the release group. To include those, use the --releaseGroup
                                      argument. Cannot be used with --all, --dir, or --packages.
                                      <options: client|server|azure|build-tools|gitrest|historian|all>

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

PACKAGE FILTER FLAGS
  --[no-]private          Only include private packages. Use --no-private to exclude private packages instead.
  --scope=<value>...      Package scopes to filter to. If provided, only packages whose scope matches the flag will be
                          included. Cannot be used with --skipScope.
  --skipScope=<value>...  Package scopes to filter out. If provided, packages whose scope matches the flag will be
                          excluded. Cannot be used with --scope.

DESCRIPTION
  Checks that all packages have the same version set in package.json. The packages checked can be filtered by standard
  criteria. THIS COMMAND IS INTENDED FOR USE IN FLUID FRAMEWORK CI PIPELINES ONLY.

See code: src/commands/check/buildVersion.ts

flub check changeset

Checks if a changeset was added when compared against a branch. This is used in CI to enforce that changesets are present for a PR.

USAGE
  $ flub check changeset -b <value> [--json] [-v | --quiet]

FLAGS
  -b, --branch=<value>  (required) The branch to compare against.

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

GLOBAL FLAGS
  --json  Format output as json.

EXAMPLES
  Check if a changeset was added when compared to the 'main' branch.

    $ flub check changeset -b main

  Check if a changeset was added when compared to the 'next' branch.

    $ flub check changeset -b next

See code: src/commands/check/changeset.ts

flub check latestVersions VERSION PACKAGE_OR_RELEASE_GROUP

Determines if an input version matches a latest minor release version. Intended to be used in the Fluid Framework CI pipeline only.

USAGE
  $ flub check latestVersions VERSION PACKAGE_OR_RELEASE_GROUP [-v | --quiet]

ARGUMENTS
  VERSION                   The version to check. When running in CI, this value corresponds to the pipeline trigger
                            branch.
  PACKAGE_OR_RELEASE_GROUP  The name of a package or a release group.

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

DESCRIPTION
  Determines if an input version matches a latest minor release version. Intended to be used in the Fluid Framework CI
  pipeline only.

  This command is used in CI to determine if a pipeline was triggered by a release branch with the latest minor version
  of a major version.

See code: src/commands/check/latestVersions.ts

flub check layers

Checks that the dependencies between Fluid Framework packages are properly layered.

USAGE
  $ flub check layers --info <value> [-v | --quiet] [--md <value>] [--dot <value>] [--logtime]

FLAGS
  --dot=<value>   Generate *.dot for GraphViz
  --info=<value>  (required) Path to the layer graph json file
  --logtime       Display the current time on every status message for logging
  --md=<value>    Generate PACKAGES.md file at this path relative to repo root

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

DESCRIPTION
  Checks that the dependencies between Fluid Framework packages are properly layered.

See code: src/commands/check/layers.ts

flub check policy

Checks and applies policies to the files in the repository, such as ensuring a consistent header comment in files, assert tagging, etc.

USAGE
  $ flub check policy [-v | --quiet] [-D <value>... | -d <value>] [-e <value>] [--listHandlers | --stdin | -p
    <value> | -f | ]

FLAGS
  -D, --excludeHandler=<value>...  Exclude policy handler by name. Can be specified multiple times to exclude multiple
                                   handlers.
  -d, --handler=<value>            Filter policy handler names by <regex>.
  -e, --exclusions=<value>         Path to the exclusions.json file.
  -f, --fix                        Fix errors if possible.
  -p, --path=<value>               Filter file paths by <regex>.
      --listHandlers               List all policy handlers by name.
      --stdin                      Read list of files from stdin.

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

DESCRIPTION
  Checks and applies policies to the files in the repository, such as ensuring a consistent header comment in files,
  assert tagging, etc.

See code: src/commands/check/policy.ts

flub check prApproval

Check if a PR has been approved by a list of users or members of a team.

USAGE
  $ flub check prApproval --repo <value> --pr <value> --token <value> [--json] [-v | --quiet] [--team <value>]
    [--approvers <value>...] [--ghActions]

FLAGS
  --approvers=<value>...  GitHub users who should be considered approvers. If at least one of these users has approved
                          the PR, it is considered approved. Cannot be used with the --team flag. You can provide
                          multiple names as a space-delimited list, e.g. '--approvers user1 user2'
  --ghActions             Set to true to output logs in a GitHub Actions-compatible format. This value will be set to
                          true automatically when running in GitHub Actions.
  --pr=<value>            (required) The PR number to check.
  --repo=<value>          (required) The name of the GitHub repository to check. This should be in the form
                          'owner/repo-name'. For example, 'microsoft/FluidFramework'
  --team=<value>          The team whose membership should be checked. If at least one of the members of the team has
                          approved the PR, it is considered approved. The team must be in the same GitHub organization
                          as the repo. Only the team name should be provided - the org is inferred from the repo
                          details.
  --token=<value>         (required) GitHub access token. This parameter should be passed using the GITHUB_TOKEN
                          environment variable for security purposes.

LOGGING FLAGS
  -v, --verbose  Enable verbose logging.
      --quiet    Disable all logging.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Check if a PR has been approved by a list of users or members of a team.

See code: src/commands/check/prApproval.ts