Skip to content

Commit 59b1878

Browse files
committed
Bump version to 0.2.0, update CHANGELOG.md
1 parent 5010b4f commit 59b1878

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1+
# 0.2.0 (29 September 2020)
2+
3+
This a bugfix release that breaks API compatibility. It fixes issues with reading OLE mini-streams,
4+
and hierarchies of directory entries. The `DataReader` API was updated to use `Int` instead of
5+
`UInt64` to avoid potential overflow issues. Corresponding `read` methods on `DataReader` can
6+
now trigger a precondition assertion if you try to read after reaching an end-of-stream position.
7+
To prevent this, you should check the value of a new `totalBytes` property on `DataReader`.
8+
9+
Additionally, basic API documentation is now generated with
10+
[`swift-doc`](https://github.com/SwiftDocOrg/swift-doc) and is now [hosted with GitHub
11+
Pages](https://coreoffice.github.io/OLEKit/).
12+
13+
**Breaking changes:**
14+
15+
- Add preconditions to `DataStream`, tweak seek API ([#3](https://github.com/CoreOffice/OLEKit/pull/3)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
16+
17+
**Closed issues:**
18+
19+
- [Bug] Storage & Stream Structure is Different while testing .hwp file ([#6](https://github.com/CoreOffice/OLEKit/issues/6))
20+
- [Bug] get wrong stream position while get "FileHeader" stream in ".hwp" file ([#1](https://github.com/CoreOffice/OLEKit/issues/1))
21+
22+
**Merged pull requests:**
23+
24+
- Fix incorrectly built entries hierarchy ([#7](https://github.com/CoreOffice/OLEKit/pull/7)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
25+
- Fix miniStream iteration bug, add HWP test ([#5](https://github.com/CoreOffice/OLEKit/pull/5)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
26+
- Generate and publish documentation with `swift-doc` ([#4](https://github.com/CoreOffice/OLEKit/pull/4)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
27+
- Fix branch name in `main.yml`, test on new Xcode ([#2](https://github.com/CoreOffice/OLEKit/pull/2)) via [@MaxDesiatov](https://github.com/MaxDesiatov)
28+
129
# 0.1.0 (31 May 2020)
230

331
Initial release of OLEKit that provides basic features for [the CryptoOffice

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,10 @@ easy as adding it to the `dependencies` value of your `Package.swift`.
9393

9494
```swift
9595
dependencies: [
96-
.package(url: "https://github.com/CoreOffice/OLEKit.git",
97-
.upToNextMinor(from: "0.1.0"))
96+
.package(
97+
url: "https://github.com/CoreOffice/OLEKit.git",
98+
.upToNextMinor(from: "0.2.0")
99+
)
98100
]
99101
```
100102

0 commit comments

Comments
 (0)