osl-incubator / makim

Make Improved
https://osl-incubator.github.io/makim/
BSD 3-Clause "New" or "Revised" License
8 stars 10 forks source link

imp : improve help text #62

Closed abhijeetSaroha closed 11 months ago

abhijeetSaroha commented 11 months ago

change the output text to this.

positional arguments:
  target
    Specify the target command to be performed. Options are:

    default:
    --------
      default.clean => Clean unnecessary temporary files

    docs:
    -----
      docs.build => Build documentation
      docs.preview => Preview documentation page locally

    release:
    --------
      release.ci => Run semantic release on CI
      release.dry => Run semantic release in dry-run mode

    tests:
    ------
      tests.linter => Run linter tools
      tests.unittest => Run tests
      tests.smoke => Run smoke tests
      tests.ci => Run all targets used on CI

    smoke-tests:
    ------------
      smoke-tests.simple => Test makim using a simple makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.complex => Test makim using a complex makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.containers => Test makim with containers-sugar
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.unittest => Test makim using a unittest makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.vars-env => Test makim using env makimfile
        ARGS:
          --verbose-mode: (bool) Run the all the tests in verbose mode
      smoke-tests.bash => ...
xmnlab commented 11 months ago

the output looks really nice!

xmnlab commented 11 months ago

looks good to me. thanks @abhijeetSaroha for working on that.

github-actions[bot] commented 10 months ago

:tada: This PR is included in version 1.9.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket: