git-journal 1.8.1

The Git Commit Message and Changelog Generation Framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

---
name: git-journal
bin_name: git journal
author: Sascha Grunert <mail@saschagrunert.de>
about: The Git Commit Message Framework
after_help: 'More info at: https://github.com/saschagrunert/git-journal'
global_settings:
  - VersionlessSubcommands
  - ColoredHelp

args:
  - path:
      short: p
      long: path
      value_name: PATH
      default_value: .
      help: Sets a custom working path.
  - revision_range:
      index: 1
      value_name: revision range
      default_value: HEAD
      help: Specifies the revision range to be processed.
        If a single revision is specified, the output will stop
        at the first following git TAG.
  - all:
      short: a
      long: all
      help: Do not stop parsing at the first tag when a single
        revision is given. Overwrites '-n/--tags-count'.
  - generate:
      short: g
      long: generate
      help: Generate a fresh output template from a commit range.
  - short:
      short: s
      long: short
      help: Print only the shortlog (summary) form.
  - skip_unreleased:
      short: u
      long: skip-unreleased
      help: Skip entries without any relation to a git TAG.
  - tags_count:
      short: n
      long: tags-count
      value_name: number of tags
      default_value: '1'
      help: The number of tags until the parser stops when a single revision is
        given.
  - tag_skip_pattern:
      short: e
      value_name: exclude git tag pattern
      default_value: rc
      help: A pattern to exclude git tags from the processing.
  - template:
      short: t
      long: template
      help: Use a custom output template.
      takes_value: true
  - output:
      short: o
      long: output
      help: The output file for the changelog.
      takes_value: true
  - ignore_tags:
      short: i
      long: ignore
      help: Ignore the given comma separated list of :tags:, like "internal"
      takes_value: true

subcommands:
  - prepare:
      about: Prepare a commit message before the user can edit it.
      visible_alias: p
      args:
        - message:
            required: true
            value_name: COMMIT_MSG
            help: The path to the commit message which should be prepared.
        - type:
            value_name: TYPE
            help: The type of the commit. For example "message".
  - setup:
      about: Creates all necessary git hooks and an initial configuration file.
        Shell completions for bash and fish will be available inside the current
        working directory.
      visible_alias: s
  - verify:
      about: Verify the specified commit message.
      visible_alias: v
      args:
        - message:
            required: true
            value_name: COMMIT_MSG
            help: The path to the commit message which should be prepared.