Have ideas to improve npm?Join in the discussion! »

    @heroku-cli/plugin-pipelines

    7.49.0 • Public • Published

    @heroku-cli/plugin-pipelines

    oclif Version CircleCI Appveyor CI Downloads/week License

    Usage

    $ npm install -g @heroku-cli/plugin-pipelines
    $ heroku COMMAND
    running command...
    $ heroku (-v|--version|version)
    @heroku-cli/plugin-pipelines/7.49.0 darwin-x64 node-v12.18.4
    $ heroku --help [COMMAND]
    USAGE
      $ heroku COMMAND
    ...

    Commands

    heroku pipelines

    list pipelines you have access to

    USAGE
      $ heroku pipelines
    
    OPTIONS
      --json  output in json format
    
    EXAMPLE
      $ heroku pipelines
    

    See code: src/commands/pipelines/index.ts

    heroku pipelines:add PIPELINE

    add this app to a pipeline

    USAGE
      $ heroku pipelines:add PIPELINE
    
    ARGUMENTS
      PIPELINE  name of pipeline
    
    OPTIONS
      -a, --app=app        (required) app to run command against
      -r, --remote=remote  git remote of app to use
      -s, --stage=stage    stage of first app in pipeline
    
    DESCRIPTION
      The app and pipeline names must be specified.
      The stage of the app will be guessed based on its name if not specified.
    
    EXAMPLE
      $ heroku pipelines:add my-pipeline -a my-app -s production
    

    See code: src/commands/pipelines/add.ts

    heroku pipelines:connect NAME

    connect a github repo to an existing pipeline

    USAGE
      $ heroku pipelines:connect NAME
    
    ARGUMENTS
      NAME  name of pipeline
    
    OPTIONS
      -r, --repo=repo  (required) the GitHub repository to connect to
    
    EXAMPLE
      $ heroku pipelines:connect my-pipeline -r githuborg/reponame
    

    See code: src/commands/pipelines/connect.ts

    heroku pipelines:create [NAME]

    create a new pipeline

    USAGE
      $ heroku pipelines:create [NAME]
    
    ARGUMENTS
      NAME  name of pipeline (defaults to basename of the app)
    
    OPTIONS
      -a, --app=app        (required) app to run command against
      -r, --remote=remote  git remote of app to use
      -s, --stage=stage    stage of first app in pipeline
      -t, --team=team      the team which will own the apps
    
    DESCRIPTION
      An existing app must be specified as the first app in the pipeline.
         The pipeline name will be inferred from the app name if not specified.
         The stage of the app will be guessed based on its name if not specified.
         The pipeline owner will be the user creating the pipeline if not specified with -t for teams or -o for orgs.
    
    EXAMPLES
      $ heroku pipelines:create -a my-app-staging
      $ heroku pipelines:create my-pipeline -a my-app-staging
    

    See code: src/commands/pipelines/create.ts

    heroku pipelines:destroy PIPELINE

    destroy a pipeline

    USAGE
      $ heroku pipelines:destroy PIPELINE
    
    ARGUMENTS
      PIPELINE  name of pipeline
    
    EXAMPLE
      $ heroku pipelines:destroy my-pipeline
    

    See code: src/commands/pipelines/destroy.ts

    heroku pipelines:diff

    compares the latest release of this app to its downstream app(s)

    USAGE
      $ heroku pipelines:diff
    
    OPTIONS
      -a, --app=app        (required) app to run command against
      -r, --remote=remote  git remote of app to use
    
    EXAMPLE
      $ heroku pipelines:diff -a my-app-staging
    

    See code: src/commands/pipelines/diff.ts

    heroku pipelines:info PIPELINE

    show list of apps in a pipeline

    USAGE
      $ heroku pipelines:info PIPELINE
    
    ARGUMENTS
      PIPELINE  pipeline to show list of apps for
    
    OPTIONS
      --json  output in json format
    
    EXAMPLE
      $ heroku pipelines:info my-pipeline
    

    See code: src/commands/pipelines/info.ts

    heroku pipelines:open PIPELINE

    open a pipeline in dashboard

    USAGE
      $ heroku pipelines:open PIPELINE
    
    ARGUMENTS
      PIPELINE  name of pipeline
    
    EXAMPLE
      $ heroku pipelines:open my-pipeline
    

    See code: src/commands/pipelines/open.ts

    heroku pipelines:promote

    promote the latest release of this app to its downstream app(s)

    USAGE
      $ heroku pipelines:promote
    
    OPTIONS
      -a, --app=app        (required) app to run command against
      -r, --remote=remote  git remote of app to use
      -t, --to=to          comma separated list of apps to promote to
    
    EXAMPLE
      $ heroku pipelines:promote -a my-app-staging
    

    See code: src/commands/pipelines/promote.ts

    heroku pipelines:remove

    remove this app from its pipeline

    USAGE
      $ heroku pipelines:remove
    
    OPTIONS
      -a, --app=app        (required) app to run command against
      -r, --remote=remote  git remote of app to use
    
    EXAMPLE
      $ heroku pipelines:remove -a my-app
    

    See code: src/commands/pipelines/remove.ts

    heroku pipelines:rename PIPELINE NAME

    rename a pipeline

    USAGE
      $ heroku pipelines:rename PIPELINE NAME
    
    ARGUMENTS
      PIPELINE  current name of pipeline
      NAME      new name of pipeline
    
    EXAMPLE
      $ heroku pipelines:rename my-pipeline new-pipeline-name
    

    See code: src/commands/pipelines/rename.ts

    heroku pipelines:setup [NAME] [REPO]

    bootstrap a new pipeline with common settings and create a production and staging app (requires a fully formed app.json in the repo)

    USAGE
      $ heroku pipelines:setup [NAME] [REPO]
    
    ARGUMENTS
      NAME  name of pipeline
      REPO  a GitHub repository to connect the pipeline to
    
    OPTIONS
      -t, --team=team  the team to assign pipeline ownership to (defaults to current user)
      -y, --yes        accept all default settings without prompting
    
    EXAMPLE
      $ heroku pipelines:setup my-pipeline githuborg/reponame -t my-team
    

    See code: src/commands/pipelines/setup.ts

    heroku pipelines:transfer OWNER

    transfer ownership of a pipeline

    USAGE
      $ heroku pipelines:transfer OWNER
    
    ARGUMENTS
      OWNER  the owner to transfer the pipeline to
    
    OPTIONS
      -c, --confirm=confirm
      -p, --pipeline=pipeline  (required) name of pipeline
    
    EXAMPLES
      $ heroku pipelines:transfer admin@example.com -p my-pipeline
      $ heroku pipelines:transfer admin-team -p my-pipeline
    

    See code: src/commands/pipelines/transfer.ts

    heroku pipelines:update

    update the app's stage in a pipeline

    USAGE
      $ heroku pipelines:update
    
    OPTIONS
      -a, --app=app        (required) app to run command against
      -r, --remote=remote  git remote of app to use
      -s, --stage=stage    (required) new stage of app
    
    EXAMPLE
      $ heroku pipelines:update -s staging -a my-app
    

    See code: src/commands/pipelines/update.ts

    heroku reviewapps:disable

    disable review apps and/or settings on an existing pipeline

    USAGE
      $ heroku reviewapps:disable
    
    OPTIONS
      -a, --app=app            parent app used by review apps
      -p, --pipeline=pipeline  (required) name of pipeline
      -r, --remote=remote      git remote of app to use
      --no-autodeploy          disable autodeployments
      --no-autodestroy         disable automatically destroying review apps
      --no-wait-for-ci         disable wait for CI
    
    EXAMPLE
      $ heroku reviewapps:disable -p my-pipeline -a my-app --no-autodeploy
    

    See code: src/commands/reviewapps/disable.ts

    heroku reviewapps:enable

    enable review apps and/or settings on an existing pipeline

    USAGE
      $ heroku reviewapps:enable
    
    OPTIONS
      -a, --app=app            parent app used by review apps
      -p, --pipeline=pipeline  (required) name of pipeline
      -r, --remote=remote      git remote of app to use
      --autodeploy             autodeploy the review app
      --autodestroy            autodestroy the review app
      --wait-for-ci            wait for CI to pass before deploying
    
    EXAMPLE
      $ heroku reviewapps:enable -p my-pipeline -a my-app --autodeploy --autodestroy
    

    See code: src/commands/reviewapps/enable.ts

    Install

    npm i @heroku-cli/plugin-pipelines

    DownloadsWeekly Downloads

    11,225

    Version

    7.49.0

    License

    MIT

    Unpacked Size

    114 kB

    Total Files

    75

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar