Skip to content

Commit a74e546

Browse files
committed
Prepare of release 2.1.2 and lint README.md and CHANGELOG.md
1 parent 9a8b3f0 commit a74e546

2 files changed

Lines changed: 16 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
56
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
67

78
We refer to [GitHub issues](https://github.com/adr/adr-log/issues) by using `#NUM`.
89

9-
## [unreleased]
10+
## [2.1.2] – 2019-10-27
11+
12+
### Fixed
13+
14+
- Updated package versions to fix vulnerabilities
1015

1116
## [2.1.1] – 2017-12-15
1217

@@ -40,39 +45,47 @@ We refer to [GitHub issues](https://github.com/adr/adr-log/issues) by using `#NU
4045
- Initial support for headers (`---`) in `ADR-*.md` files.
4146

4247
### Changed
48+
4349
- Updated CLI syntax to be more conform with [markdown-toc](https://github.com/jonschlinkert/markdown-toc).
4450

4551
### Fixed
52+
4653
- The title of the first main heading is used (and not the second line if it is not empty). [#15](https://github.com/adr/adr-log/issues/15)
4754
- When `adrlog` appears without closing `adrlogstop`, adr-log does not stop with an error anymore.
4855
- When `adrlog` does not appear, the log is created nevertheless.
4956

5057
## [1.1.0] – 2017-10-27
5158

5259
### Added
60+
5361
- We added a CHANGELOG.md. [#2](https://github.com/adr/adr-log/issues/2)
5462

5563
### Changed
64+
5665
- We update README.md to reflect changed usage. [#3](https://github.com/adr/adr-log/issues/3)
5766

5867
### Fixed
68+
5969
- Fix titles to printed in the correct format as described in [#5](https://github.com/adr/adr-log/issues/5).
6070
- Fix output of help to use "LOG" instead of "TOC". [#6](https://github.com/adr/adr-log/issues/6)
6171
- Fix help to output "adr-log" instead of "adr-toc". [#4](https://github.com/adr/adr-log/issues/4)
6272

6373
### Removed
74+
6475
- Removed `bower.json`. [#8](https://github.com/adr/adr-log/issues/8)
6576

6677
## [1.0.1] – 2017-10-22
6778

6879
### Fixed
80+
6981
- Fix parsing of cli arguments. [#1](https://github.com/adr/adr-log/issues/1)
7082

7183
## [1.0.0] – 2017-10-20
7284

7385
Initial version of adr-log.
7486

75-
[unreleased]: https://github.com/adr/adr-log/compare/adr:2.1.1...master
87+
[unreleased]: https://github.com/adr/adr-log/compare/adr:2.1.2...master
88+
[2.1.2]: https://github.com/adr/adr-log/compare/adr:2.1.1...2.1.2
7689
[2.1.1]: https://github.com/adr/adr-log/compare/adr:2.1.0...2.1.1
7790
[2.1.0]: https://github.com/adr/adr-log/compare/adr:2.0.0...2.1.0
7891
[2.0.0]: https://github.com/adr/adr-log/compare/adr:1.1.0...2.0.0

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ npm install -g adr-log
2828

2929
## CLI
3030

31-
```
31+
```text
3232
Usage: adr-log [-d <directory>] [-i] <input>
3333
3434
input: The markdown file to contain the table of contents.
@@ -54,7 +54,6 @@ Usage: adr-log [-d <directory>] [-i] <input>
5454
Consider a directory consisting of three files (`0000-example-1.md`, `0001-example-2.md`, `0002-example-3.md`).
5555
Execute following command:
5656

57-
5857
```sh
5958
$ adr-log -d .
6059
```
@@ -92,7 +91,6 @@ Result in following `index.md`:
9291
<!-- adrlogstop -->
9392
```
9493

95-
9694
## Developing
9795

9896
- Run `node cli.js` to execute the CLI.
@@ -102,7 +100,6 @@ Result in following `index.md`:
102100
- Use [relase-it](https://www.npmjs.com/package/release-it) and [github-release-from-changelog](https://github.com/MoOx/github-release-from-changelog) for release management.
103101
See also [ADR-0003](docs/adr/0003-use-release-it-and-github-release-from-changelog-as-release-tooling.md).
104102

105-
106103
## Related Tooling
107104

108105
[adr-tools](https://github.com/npryce/adr-tools) is the most prominent related tool.
@@ -114,7 +111,6 @@ The difference to adr-log is
114111
1. adr-log is available using `npm` and thus more easy to install.
115112
2. adr-tools does not include the heading of each ADR into the output.
116113

117-
118114
## License
119115

120116
Copyright © 2017 [Tino Stadelmaier](https://github.com/tstadelmaier), [Oliver Kopp](https://github.com/koppor), [Armin Hüneburg](https://github.com/hueneburg), [Tobias Wältken](https://github.com/mee4895).

0 commit comments

Comments
 (0)