Skip to content

Commit

Permalink
3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelklishin committed Jul 21, 2024
1 parent 1ad3c24 commit 0084c8a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 13 deletions.
26 changes: 25 additions & 1 deletion ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
## Changes Between 2.16.0 and 2.17.0 (in development)
## Changes Between 3.0.0 and 3.1.0 (unreleased)

No changes yet.


## Changes Between 2.16.0 and 3.0.0 (Jul 20, 2024)

### Why the Major Version Bump?

There aren't any major breaking API changes. However, given
the ongoing evolution of the RabbitMQ HTTP API, in particular in the 4.x
development lifecycle, it makes sense to bump the major version of
this client and continue tracking RabbitMQ `3.13.x` and (in development
at the time of writing) `4.x`.

### Removed Sockets Metrics

They will be gone starting with RabbitMQ 4.x. These are [OS-level metrics](https://www.rabbitmq.com/docs/monitoring#system-metrics)
and should be monitored as such.

GitHub issue: [#313](https://github.com/michaelklishin/rabbit-hole/pull/313).

### Exchange Auto-Deletion Field Had an Incorrect Default

Contributed by @pafmaf.

GitHub issue: [#312](https://github.com/michaelklishin/rabbit-hole/pull/312)


## Changes Between 2.15.0 and 2.16.0 (Jan 4, 2023)

### Definition Upload for a Single Virtual Host
Expand Down
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rabbit Hole, a RabbitMQ HTTP API Client for Go

This library is a [RabbitMQ HTTP API](https://raw.githack.com/rabbitmq/rabbitmq-management/rabbitmq_v3_6_0/priv/www/api/index.html) client for the Go language.
This library is a [RabbitMQ HTTP API](https://rawcdn.githack.com/rabbitmq/rabbitmq-server/v3.13.5/deps/rabbitmq_management/priv/www/api/index.html) client for the Go language.

## Supported Go Versions

Expand All @@ -10,24 +10,17 @@ Older versions may work but this is not guaranteed.

## Supported RabbitMQ Versions

* All [currently supported RabbitMQ versions](https://www.rabbitmq.com/versions.html)
* [RabbitMQ `3.9.x`](https://www.rabbitmq.com/changelog.html) will be the minimum supported release series starting with Rabbit Hole 3.0
* Almost all API operations work against RabbitMQ `3.8.x` nodes. Some metrics and stats may be missing.
* RabbitMQ `3.8.x` and older versions have [reached end of general support](https://www.rabbitmq.com/versions.html)
This library targets the [community supported RabbitMQ release series](https://www.rabbitmq.com/release-information).

All versions require [RabbitMQ Management UI plugin](https://www.rabbitmq.com/management.html) to be installed and enabled.
All versions require [RabbitMQ Management UI plugin](https://www.rabbitmq.com/docs/management/) to be installed and enabled.

## Build Status

[![Travis CI](https://travis-ci.org/michaelklishin/rabbit-hole.svg?branch=master)](https://travis-ci.org/michaelklishin/rabbit-hole.svg?branch=master)
[![Tests](https://github.com/michaelklishin/rabbit-hole/actions/workflows/tests.yml/badge.svg)](https://github.com/michaelklishin/rabbit-hole/actions/workflows/tests.yml)

## Project Maturity

Rabbit Hole is a mature library (first released in late 2013)
designed after a couple of other RabbitMQ HTTP API clients with stable
APIs. Breaking API changes are not out of the question but not without
a reasonable version bump.
Rabbit Hole is a mature library (first released in late 2013).

It is largely feature complete and decently documented.

Expand Down Expand Up @@ -501,4 +494,4 @@ See [CONTRIBUTING.md](https://github.com/michaelklishin/rabbit-hole/blob/master/

2-clause BSD license.

(c) Michael S. Klishin and contributors, 2013-2023.
(c) Michael S. Klishin and contributors, 2013-2024.

0 comments on commit 0084c8a

Please sign in to comment.