blob: f74d28c16f249198f1db4c5378fb38fd70faf10e (
plain)
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
|
# The `changelog` LaTeX package
Changelogs are important. Unfortunately, there are few facilities
for typesetting changelogs in LaTeX. `changelog` defines a `changelog`
environment to make changelogs simple and intuitive.
Inspired by [keepachangelog.com].
File | Description
-----------------------------|-------------------------------
changelog.sty | The changelog package
changelog.pdf | Documentation (English)
changelog.tex | Documentation source
changelog-doc.sty | Documentation styles
README.md | This file
LICENSE.md | GNU GPLv3
## Example
\documentclass{article}
\usepackage[color]{changelog}
\begin{document}
\begin{changelog}[author=Rebecca Turner]
\begin{version}
\added Really cool features
\end{version}
\begin{version}[date=2019-01-23]
\item A version with only a date
\end{version}
\begin{version}[v=1.1.0]
\item A version with no date
\end{version}
\begin{version}[v=1.0.1, yanked]
\item A version with a terrible bug
\end{version}
\begin{version}[v=1.0.0, date=2018-10-26]
\added a cool feature
\changed some \textsc{api} detail
\deprecated something that was a bad idea in the first place
\removed something that was deprecated 3 versions ago
\fixed a bug that would delete files instead of saving them
\security improved with addition of buffer bound checks
\item A change that doesn't fit into any other category
\end{version}
\shortversion{v=0.1.0, date=2018-10-19,
changes=Initial beta.}
\end{changelog}
\end{document}
Which renders roughly as:
[keepachangelog.com]: https://keepachangelog.com/
|
