Skip to content

Commit

Permalink
Prepare Goose for 0.6.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
olttwa committed Oct 9, 2024
1 parent 656fea9 commit f12ded1
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 30 deletions.
53 changes: 23 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,48 @@
Goose
=========
<p align="center">
<img src="logo/goose-round@2x.png" title="Goose" width="360" height="360" />
</p>

[![Test & Lint Workflow](https://github.com/nilenso/goose/actions/workflows/fmt_test_lint.yml/badge.svg)](https://github.com/nilenso/goose/actions/workflows/fmt_test_lint.yml)
[![Clojars Project](https://img.shields.io/clojars/v/com.nilenso/goose.svg)](https://clojars.org/com.nilenso/goose)
[![cljdoc badge](https://cljdoc.org/badge/com.nilenso/goose)](https://cljdoc.org/d/com.nilenso/goose)

The Next-Level background job processing library for Clojure.
> **Simple. Pluggable. Reliable. Extensible. Scalable.**
### Simple. Pluggable. Reliable. Extensible. Scalable.
A powerful background job processing library for Clojure. Goose is named after [LT Nick 'Goose' Bradshaw](https://topgun.fandom.com/wiki/Nick_Bradshaw), the _sidekick_ to [Captain Pete 'Maverick' Mitchell](https://topgun.fandom.com/wiki/Pete_Mitchell) in Top Gun.

Announcement 🔈
---------
We are excited to announce that **5 companies** are using Goose successfully and reliably in production environments. With the release of the [Jobs Management Console](https://github.com/nilenso/goose/wiki/Console), Goose has reached a level of maturity, offering a feature-rich, stable, and production-ready background job processing solution.
We are excited to announce that **five companies** are successfully and reliably using Goose in production environments. With the release of a [Jobs Management Console](https://github.com/nilenso/goose/wiki/Console), Goose has reached a level of maturity, offering a feature-rich, stable, and production-ready background job processing solution.

We plan to release **Goose 1.0.0** on **February 1st, 2025**, marking API stability and ensuring backward-compatibility, with no downtime during upgrades.

We welcome feedback from current and new users, especially if you’d like to request features or suggest changes to the API or implementation before the 1.0.0 release. Please review our [Architecture Decisions](https://github.com/nilenso/goose/tree/main/architecture-decisions) and [Wiki](https://github.com/nilenso/goose/wiki) for more context, and share your thoughts via [GitHub Issues](https://github.com/nilenso/goose/issues/new) or the [Clojurians Slack](https://clojurians.slack.com/channels/goose).

Performance
---------
Please refer to the [Benchmarking section](https://github.com/nilenso/goose/tree/main/perf).

Features
---------
- *Reliable* - Code/Hardware/Network failure won't cause data loss
- Native support for RabbitMQ & Redis
- Native support for RabbitMQ & Redis queues
- Pluggable [Message Broker](https://github.com/nilenso/goose/wiki/Guide-to-Message-Broker-Integration) & [Metrics Backend](https://github.com/nilenso/goose/wiki/Guide-to-Custom-Metrics-Backend)
- [Jobs management Console](https://github.com/nilenso/goose/wiki/Console)
- [Scheduled Jobs](https://github.com/nilenso/goose/wiki/Scheduled-Jobs)
- [Batch Jobs](https://github.com/nilenso/goose/wiki/Batch-Jobs)
- [Cron Jobs](https://github.com/nilenso/goose/wiki/Cron-Jobs)
- [Error Handling & Retries](https://github.com/nilenso/goose/wiki/Error-Handling-&-Retries)
- [Jobs management Console](https://github.com/nilenso/goose/wiki/Console)
- Extensible using [Middlewares](https://github.com/nilenso/goose/wiki/Middlewares)
- Performant and scalable (refer [performance benchmarks](https://github.com/nilenso/goose/tree/main/perf))
- Concurrency & Parallelism friendly
- ... more details in [Goose Wiki](https://github.com/nilenso/goose/wiki)

Companies using Goose in Production
---------
<a href="https://aspect-analytics.com/">
<img src="logo/aspect-analytics.png" title="Aspect Analytics" width="150" height="150" />
</a>
<a href="https://beecastle.com/">
<img src="logo/beecastle.png" title="BeeCastle" width="150" height="150" />
</a>

Getting Started
---------
[![Clojars Project](https://img.shields.io/clojars/v/com.nilenso/goose.svg?labelColor=283C67&color=729AD1&style=for-the-badge&logo=clojure&logoColor=fff)](https://clojars.org/com.nilenso/goose)
Expand Down Expand Up @@ -81,40 +91,23 @@ com.nilenso/goose {:mvn/version "0.6.0"}
worker-opts (assoc w/default-opts :broker rmq-consumer)
worker (w/start worker-opts)]
;; When shutting down worker...
(w/stop worker) ; Performs graceful shutsdown.
(w/stop worker) ; Performs a graceful shutsdown.
(rmq/close rmq-consumer))
```
Refer to wiki for [Redis](https://github.com/nilenso/goose/wiki/Redis), [Cron Jobs](https://github.com/nilenso/goose/wiki/Cron-Jobs), [Error Handling](https://github.com/nilenso/goose/wiki/Error-Handling-&-Retries), [Monitoring](https://github.com/nilenso/goose/wiki/Monitoring-&-Alerting), [Production Readiness](https://github.com/nilenso/goose/wiki/Production-Readiness), etc.
Refer to wiki for [Redis queue](https://github.com/nilenso/goose/wiki/Redis), [Jobs management Console](https://github.com/nilenso/goose/wiki/Console), [Batch Jobs](https://github.com/nilenso/goose/wiki/Batch-Jobs), [Cron Jobs](https://github.com/nilenso/goose/wiki/Cron-Jobs), [Error Handling](https://github.com/nilenso/goose/wiki/Error-Handling-&-Retries), [Monitoring](https://github.com/nilenso/goose/wiki/Monitoring-&-Alerting), [Production Readiness](https://github.com/nilenso/goose/wiki/Production-Readiness) and more.

Getting Help
---------
[![Get help on Slack](http://img.shields.io/badge/slack-clojurians%20%23goose-F49109?labelColor=3c0c3c&logo=slack&style=for-the-badge)](https://clojurians.slack.com/channels/goose)

Please [open an issue](https://github.com/nilenso/goose/issues/new) or ping us on [#goose @Clojurians slack](https://clojurians.slack.com/channels/goose).

Companies using Goose in Production
License
---------
<a href="https://aspect-analytics.com/">
<img src="logo/aspect-analytics.png" title="Aspect Analytics" width="150" height="150" />
</a>
<a href="https://beecastle.com/">
<img src="logo/beecastle.png" title="BeeCastle" width="150" height="150" />
</a>
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)

Contributing
---------
- As a first step, go through all the [architecture-decisions](https://github.com/nilenso/goose/tree/main/architecture-decisions)
- Discuss with maintainers on the [issues page](https://github.com/nilenso/goose/issues) or at [#goose @Clojurians slack](https://clojurians.slack.com/channels/goose)
- See [the contributing guide](https://github.com/nilenso/goose/blob/main/CONTRIBUTING.md) for setup & guidelines

Why the name "Goose"?
---------
<p align="center">
<img src="logo/goose-round@2x.png" title="Goose" width="360" height="360" />
</p>

Named after [LT Nick 'Goose' Bradshaw](https://topgun.fandom.com/wiki/Nick_Bradshaw), the _sidekick_ to [Captain Pete 'Maverick' Mitchell](https://topgun.fandom.com/wiki/Pete_Mitchell) in Top Gun.

License
---------
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)
2 changes: 2 additions & 0 deletions architecture-decisions/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Goose Architecture Decisions
==========

The architecture and design philosophy of Goose are elaborated in [this IN/Clojure 2024 talk](https://youtu.be/GQ1It09DLM0).

Vision & Philosophy
----------

Expand Down

0 comments on commit f12ded1

Please sign in to comment.