Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ At GitHub, we manage thousands of nodes with a Puppet code base containing 500,0

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

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.
**The current version of `octocatalog-diff` in the master branch is 0.99.rc1, a release candidate for version 1.0.**

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.

## How?

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

### Project

- [Roadmap](/doc/roadmap.md)
- [Similar tools](/doc/similar.md)
- [Contributing](/.github/CONTRIBUTING.md)
- [Developer documentation](/doc/dev)
- [API documentation](/doc/dev/api.md)

## What's in a name?

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

## Authors

`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.
`octocatalog-diff` was designed and authored by [Kevin Paulisse](https://github.com/kpaulisse) and is now maintained, reviewed, and tested by Kevin and the rest of the Site Reliability Engineering team at GitHub.
7 changes: 4 additions & 3 deletions doc/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
</thead><tbody>
<tr valign=top>
<td>0.99.0rc1</td>
<td>2017-xx-xx</td>
<td>2017-01-16</td>
<td>
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>.
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>.

The previous release (0.6.1) is available at: https://github.com/github/octocatalog-diff/tree/0.6.1

<h4>New Features</h4>

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

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.

</td>
</tr>
<tr valign=top>
Expand Down