factorial-io / phabalicious

Supports your deployments and every-day devops-tasks
http://docs.phab.io
MIT License
18 stars 3 forks source link

Show better info #170

Closed stmh closed 3 years ago

stmh commented 3 years ago

This MR will allow configuration to have descriptive information attached via

hosts:
  mbb:
    info:
      description: This is a description
      publicUrls:
        - https://www.example.com
        - https://admin.example.com
        - https://db.example.com
  bar:
    host: foo.bar
    info:
      description: |-
        Another configuration for foo.bar. can have multiple lines
        but be sure to hard-break them.

        phabalicious won't reformat them for you.
      publicUrl: https://%host.host%

This info will be shown on list:hosts when the verbosity is increased. (phab list:hosts -v) Without -v only the main public url will be shown next to the configuration name.

The main public url (the first on of the list) will be also shown next to the config name when tasks succeeded to make it easier for the user.

description and publicUrl|s can also contain replacement patterns for the host, they will be replace with the actual value before displaying the information to the user.

The output of above example:

phab list:hosts 

List of found host-configurations:
==================================

  * mbb  [https://www.example.com]
  * bar  [https://foo.bar]