Skip to content

Commit c329a87

Browse files
authored
Merge pull request #59 from github/kpaulisse-release-1-0-doc
Documentation and readme update for 1.0 release
2 parents 66383a9 + 9d9c786 commit c329a87

File tree

4 files changed

+19
-3
lines changed

4 files changed

+19
-3
lines changed

.version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.6.1
1+
0.99.rc1

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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-
It is under active development at this time. We suspect that with the initial release, some people who try it out could be using configurations of Puppet that we haven't experienced within our environment. We are eager to identify and fix as many of these as we can to expand the compatibility of this tool as much as possible.
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.
1212

1313
## How?
1414

doc/CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@
88
</tr>
99
</thead><tbody>
1010
<tr valign=top>
11+
<td>0.99.0rc1</td>
12+
<td>2017-xx-xx</td>
13+
<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>.
15+
16+
<h4>New Features</h4>
17+
18+
The most significant change in version 1.0 is the addition of the <a href="./dev/api.md">V1 API</a>, which permits developers to build catalogs (<code>--catalog-only</code>) and compare/diff catalogs using octocatalog-diff. Under the hood, we've rearranged the code to support these APIs, which should also improve the reliability and allow faster development cycles.
19+
20+
<h4>Breaking Changes</h4>
21+
22+
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+
24+
</td>
25+
</tr>
26+
<tr valign=top>
1127
<td>0.6.1</td>
1228
<td>2017-01-07</td>
1329
<td>

doc/dev/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
The octocatalog-diff API allows developers to construct and work with certain octocatalog-diff internals in their own projects.
44

5-
The current API version is [API v1](/doc/dev/api/v1.md), which is available as of octocatalog-diff version 0.7.
5+
The current API version is [API v1](/doc/dev/api/v1.md), which is available as of octocatalog-diff version 1.0.

0 commit comments

Comments
 (0)