Skip to content

Commit ec5dc40

Browse files
committed
Updated documentation
1 parent f5ad0c8 commit ec5dc40

15 files changed

Lines changed: 304 additions & 138 deletions

docsrc/actions/metadata.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,33 @@
55
### Arguments
66

77
commit_metadata
8+
9+
In Git, trailers are key-value pairs written inside of commit messages that, make things like issue references programmatically accessible. For example, the following commit message:
10+
11+
```
12+
Awesome new feature
13+
14+
Some details about this commit
15+
16+
Closes: #1234
17+
```
18+
19+
The last line is an example for a trailer. It consists of a token (`Closes`), a separator (`:`), and a value (`#1234`).
20+
21+
22+
23+
This action will convert the above commit message to:
24+
25+
```
26+
Awesome new feature
27+
28+
Some details about this commit
29+
```
30+
31+
And add set `metadata.trailers.Closes` to `#1234` for easy reference in the template.
32+
33+
More info
34+
35+
https://git.wiki.kernel.org/index.php/CommitMessageConventions
36+
37+
https://lore.kernel.org/git/60ad75ac7ffca_2ae08208b@natae.notmuch/

docsrc/api.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ API Reference
99
:recursive:
1010

1111
~actions
12+
~cli
1213
~configuration
14+
~context
1315
~data_merge
1416
~git_ops
15-
~lazy
1617
~pipeline
1718
~templating
1819
~utilities
20+
~_attr_docs

docsrc/commit-organization.svg

Lines changed: 4 additions & 0 deletions
Loading

docsrc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@
6969
"tasklist",
7070
"fieldlist",
7171
]
72+
myst_heading_anchors = 2
7273
intersphinx_mapping = {
7374
"python": ("https://docs.python.org/3", None),
7475
"gitpython": ("https://gitpython.readthedocs.io/en/stable/", None),

docsrc/configuration-spec.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

0 commit comments

Comments
 (0)