Skip to content

Commit 0417b6b

Browse files
committed
Add README section on 'yanked' releases.
1 parent 82d507f commit 0417b6b

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44
## [Unreleased][head]
55
- No significant changes.
66

7+
## [0.0.6][v0.0.6] - 2014-12-12
8+
### Added
9+
- README section on "yanked" releases.
10+
711
## [0.0.5][v0.0.5] - 2014-08-09
812
### Added
913
- Markdown links to version tags on release headings

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,19 @@ or contribute to it, much like [open source project badges](http://shields.io).
111111
When I refer to a "change log", I'm talking about the function of this
112112
file: to log changes.
113113

114+
## What about yanked releases?
115+
Yanked releases are versions that had to be pulled because of a serious
116+
bug or security issue. Often these versions don't even appear in change
117+
logs. They should. This is how you should display them:
118+
119+
```
120+
## 0.0.5 - 2014-12-13 [YANKED]
121+
```
122+
123+
The `[YANKED]` tag is loud for a reason. It's important for people to
124+
notice it. Since it's surrounded by brackets it's also easier to parse
125+
programmatically.
126+
114127
### How can I contribute?
115128
This document is not the **truth**; it’s my carefully considered
116129
opinion, along with information and examples I gathered.

0 commit comments

Comments
 (0)