Skip to content

Commit 74f5cc5

Browse files
author
Kevin Paulisse
committed
Update readme and changelog for 0.99.rc1 release
1 parent 9921607 commit 74f5cc5

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ At GitHub, we manage thousands of nodes with a Puppet code base containing 500,0
88

99
`octocatalog-diff` is written in Ruby and is distributed as a gem. It runs on Mac OS and Unix/Linux platforms.
1010

11-
We consider the 1.x release of `octocatalog-diff` to be stable and production-quality. We continue to maintain and enhance `octocatalog-diff` to meet our own internal needs and to incorporate suggestions from the community. Please consult the [change log](/doc/CHANGELOG.md) for details.
11+
**The current version of `octocatalog-diff` in the master branch is 0.99.rc1, a release candidate for version 1.0.**
12+
13+
We consider the 1.x release of `octocatalog-diff` to be stable and production-quality. We continue to maintain and enhance `octocatalog-diff` to meet GitHub's internal needs and to incorporate suggestions from the community. Please consult the [change log](/doc/CHANGELOG.md) for details.
1214

1315
## How?
1416

@@ -51,14 +53,14 @@ The example above reflects the changes in the Puppet catalog from switching an u
5153
- [Requirements](/doc/requirements.md)
5254
- [Limitations](/doc/limitations.md)
5355
- [List of all command line options](/doc/optionsref.md)
54-
- [API](/doc/dev/api.md)
5556

5657
### Project
5758

5859
- [Roadmap](/doc/roadmap.md)
5960
- [Similar tools](/doc/similar.md)
6061
- [Contributing](/.github/CONTRIBUTING.md)
6162
- [Developer documentation](/doc/dev)
63+
- [API documentation](/doc/dev/api.md)
6264

6365
## What's in a name?
6466

@@ -80,4 +82,4 @@ It requires 3rd party ruby gems found [here](/vendor/cache). It also includes po
8082

8183
## Authors
8284

83-
`octocatalog-diff` was designed and authored by [Kevin Paulisse](https://github.com/kpaulisse) and is now maintained, reviewed, and tested by the Site Reliability Engineering team at GitHub.
85+
`octocatalog-diff` was designed and authored by [Kevin Paulisse](https://github.com/kpaulisse) and is now maintained, reviewed, and tested by the Kevin and the rest of the Site Reliability Engineering team at GitHub.

doc/CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@
99
</thead><tbody>
1010
<tr valign=top>
1111
<td>0.99.0rc1</td>
12-
<td>2017-xx-xx</td>
12+
<td>2017-01-16</td>
1313
<td>
14-
This is a release candidate for `octocatalog-diff` version 1.0. Please use caution before using this in a production environment. Report any problems to us as <a href="https://github.com/github/octocatalog-diff/issues/new">in a new issue</a>.
14+
This is a release candidate for `octocatalog-diff` version 1.0. Please report any problems to us as <a href="https://github.com/github/octocatalog-diff/issues/new">in a new issue</a>.
15+
16+
The previous release (0.6.1) is available at: https://github.com/github/octocatalog-diff/tree/0.6.1
1517

1618
<h4>New Features</h4>
1719

@@ -20,7 +22,6 @@ The most significant change in version 1.0 is the addition of the <a href="./dev
2022
<h4>Breaking Changes</h4>
2123

2224
The format of the output from <code>--output-format json</code> has changed. In version 0.x of the software, each difference was represented by an array. In version 1.x, each difference is represented by a hash with meaningful English keys. We have added an option <code>--output-format legacy_json</code> if anyone depends upon the output in the old format.
23-
2425
</td>
2526
</tr>
2627
<tr valign=top>

0 commit comments

Comments
 (0)