Page MenuHomePhabricator

scap help needs updating
Closed, ResolvedPublic

Description

reedy@deploy1002:/srv/mediawiki-staging$ scap --help
usage: scap [-h] <command> ...

optional arguments:
  -h, --help            show this help message and exit

scap commands:
  Available scap commands are listed below. For help with a particular
  command, run `scap <command> -h`

  <command>
    apply-patches       Apply security patches for train
    backport            list eligible backports
    clean               Scap sub-command to clean old branches.
    deploy              [SCAP 3] Sync new service code across cluster
    deploy-log          [SCAP 3] Tail/filter/output events from the deploy
                        logs
    lock                Temporarily lock deployment of this repository
    patch               Scap sub-command to manage mediawiki security patches
    prep                Checkout MediaWiki version to staging
    pull                Sync local MediaWiki deployment directory with deploy
                        server state (formerly sync-common)
    security-check      Check if security patches are applied.
    sync                Deploy MediaWiki to the cluster (formerly scap)
    sync-canary         Sync specific canary hosts.
    sync-file           Sync a specific file/directory to the cluster.
    sync-l10n           Sync l10n files for a given branch and rebuild cache
                        files.
    sync-wikiversions   Rebuild and sync wikiversions.php to the cluster.
    sync-world          Deploy MediaWiki to the cluster
    test-progress       Display a mock progress bar
    update-interwiki-cache
                        Scap sub-command to update the interwiki cache.
    update-wikiversions
                        Scap subcommand for updating staging dir
                        wikiversions.json to a new version.
    version             Show the version number and exit
    wikiversions-inuse  Get a list of the active MediaWiki versions.
    wmf-beta-autoupdate
                        Scap subcommand for auto-updating a beta cluster.
reedy@deploy1002:/srv/mediawiki-staging$ scap sync
[ERROR] "scap sync" has been renamed to "scap sync-world".
Use "scap sync-world" or "scap sync-file" instead,
depending on what you want to achieve.

If scap sync no longer works, the help should at least note this rather than leaving the user to get an error

Related Objects

StatusSubtypeAssignedTask
Resolvedjnuche
Resolvedjnuche

Event Timeline

jnuche claimed this task.
jnuche added a subscriber: jnuche.

After completion of T301716: Delete scap sync command, help output no longer shows sync as an available command:

usage: scap [-h] <command> ...

optional arguments:
  -h, --help                show this help message and exit

scap commands:
  Available scap commands are listed below. For help with a particular
  command, run `scap <command> -h`

  <command>
    apply-patches           Apply security patches for train
    backport                list eligible backports
    clean                   Scap sub-command to clean old branches.
    deploy                  [SCAP 3] Sync new service code across cluster
    deploy-log              [SCAP 3] Tail/filter/output events from the deploy
                            logs
    lock                    Temporarily lock deployment of this repository
    patch                   Scap sub-command to manage mediawiki security
                            patches
    prep                    Checkout MediaWiki version to staging
    pull                    Sync local MediaWiki deployment directory with
                            deploy server state (formerly sync-common)
    security-check          Check if security patches are applied.
    sync-canary             Sync specific canary hosts.
    sync-file               Sync a specific file/directory to the cluster.
    sync-l10n               Sync l10n files for a given branch and rebuild
                            cache files.
    sync-wikiversions       Rebuild and sync wikiversions.php to the cluster.
    sync-world              Deploy MediaWiki to the cluster
    test-progress           Display a mock progress bar
    update-interwiki-cache  Scap sub-command to update the interwiki cache.
    update-wikiversions     Scap subcommand for updating staging dir
                            wikiversions.json to a new version.
    version                 Show the version number and exit
    wikiversions-inuse      Get a list of the active MediaWiki versions.
    wmf-beta-autoupdate     Scap subcommand for auto-updating a beta cluster.