0
0
mirror of https://github.com/thegeeklab/git-sv.git synced 2024-11-14 07:40:40 +00:00

docs: add config on available commands

This commit is contained in:
Beatriz Vieira 2021-02-15 03:31:56 -03:00
parent 717edfbb1c
commit fd01367a1f

View File

@ -149,18 +149,19 @@ git-sv rn -h
##### Available commands ##### Available commands
| Variable | description | has options | | Variable | description | has options or subcommands |
| ---------------------------- | ------------------------------------------------------------- | :----------------: | | ---------------------------- | ------------------------------------------------------------- | :------------------------: |
| current-version, cv | get last released version from git | :x: | | config, cfg | show config information | :heavy_check_mark: |
| next-version, nv | generate the next version based on git commit messages | :x: | | current-version, cv | get last released version from git | :x: |
| commit-log, cl | list all commit logs according to range as jsons | :heavy_check_mark: | | next-version, nv | generate the next version based on git commit messages | :x: |
| commit-notes, cn | generate a commit notes according to range | :heavy_check_mark: | | commit-log, cl | list all commit logs according to range as jsons | :heavy_check_mark: |
| release-notes, rn | generate release notes | :heavy_check_mark: | | commit-notes, cn | generate a commit notes according to range | :heavy_check_mark: |
| changelog, cgl | generate changelog | :heavy_check_mark: | | release-notes, rn | generate release notes | :heavy_check_mark: |
| tag, tg | generate tag with version based on git commit messages | :x: | | changelog, cgl | generate changelog | :heavy_check_mark: |
| commit, cmt | execute git commit with convetional commit message helper | :x: | | tag, tg | generate tag with version based on git commit messages | :x: |
| validate-commit-message, vcm | use as prepare-commit-message hook to validate commit message | :heavy_check_mark: | | commit, cmt | execute git commit with convetional commit message helper | :x: |
| help, h | shows a list of commands or help for one command | :x: | | validate-commit-message, vcm | use as prepare-commit-message hook to validate commit message | :heavy_check_mark: |
| help, h | shows a list of commands or help for one command | :x: |
##### Use range ##### Use range