Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to main #230

Merged
merged 4 commits into from
Jan 12, 2021
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
### Changed

- Use GitHub Actions for the CI build instead of Travis CI ([#228]).
- This project now uses `main` as its default branch ([#230]).
- Documentation updated to refer to `main` and links updated accordingly.

[#228]: https://github.com/envato/event_sourcery/pull/228
[#229]: https://github.com/envato/event_sourcery/pull/229
[#230]: https://github.com/envato/event_sourcery/pull/230

## [0.23.1] - 2020-10-02
### Fixed
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EventSourcery

[![Build Status](https://github.com/envato/event_sourcery/workflows/tests/badge.svg?branch=master)](https://github.com/envato/event_sourcery/actions?query=workflow%3Atests+branch%3Amaster)
[![Build Status](https://github.com/envato/event_sourcery/workflows/tests/badge.svg?branch=main)](https://github.com/envato/event_sourcery/actions?query=workflow%3Atests+branch%3Amain)

A framework for building event sourced, CQRS applications.

Expand Down Expand Up @@ -105,7 +105,7 @@ To release a new version:

1. Update the version number in `lib/event_sourcery/version.rb`
2. Add the new version with release notes to CHANGELOG.md
3. Get these changes onto master via the normal PR process
3. Get these changes onto main via the normal PR process
4. Run `bundle exec rake release`, this will create a git tag for the
version, push tags up to GitHub, and package the code in a `.gem` file.

Expand Down Expand Up @@ -218,7 +218,7 @@ The event store is a persistent store of events.

EventSourcery currently supports a Postgres-based event store via the [event_sourcery-postgres gem](https://github.com/envato/event_sourcery-postgres).

For more information about the `EventStore` API refer to [the postgres event store](https://github.com/envato/event_sourcery-postgres/blob/master/lib/event_sourcery/postgres/event_store.rb) or the [in memory event store in this repo](lib/event_sourcery/memory/event_store.rb)
For more information about the `EventStore` API refer to [the postgres event store](https://github.com/envato/event_sourcery-postgres/blob/HEAD/lib/event_sourcery/postgres/event_store.rb) or the [in memory event store in this repo](lib/event_sourcery/memory/event_store.rb)

#### Storing Events

Expand Down Expand Up @@ -294,7 +294,7 @@ Reactors can be used to build [process managers or sagas](https://msdn.microsoft

#### Running Multiple ESPs

An EventSourcery application will typically have multiple ESPs running. EventSourcery provides a class called [ESPRunner](lib/event_sourcery/event_processing/esp_runner.rb) which can be used to run ESPs. It runs each ESP in a forked child process so each ESP can process the event store independently. You can find an example in [event_sourcery_todo_app](https://github.com/envato/event_sourcery_todo_app/blob/master/Rakefile).
An EventSourcery application will typically have multiple ESPs running. EventSourcery provides a class called [ESPRunner](lib/event_sourcery/event_processing/esp_runner.rb) which can be used to run ESPs. It runs each ESP in a forked child process so each ESP can process the event store independently. You can find an example in [event_sourcery_todo_app](https://github.com/envato/event_sourcery_todo_app/blob/HEAD/Rakefile).

Note that you may instead choose to run each ESP in their own process directly. The coordination of this is not currently provided by EventSourcery.

Expand Down
2 changes: 1 addition & 1 deletion event_sourcery.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
spec.homepage = 'https://github.com/envato/event_sourcery'
spec.metadata = {
'bug_tracker_uri' => 'https://github.com/envato/event_sourcery/issues',
'changelog_uri' => 'https://github.com/envato/event_sourcery/blob/master/CHANGELOG.md',
'changelog_uri' => 'https://github.com/envato/event_sourcery/blob/HEAD/CHANGELOG.md',
'source_code_uri' => 'https://github.com/envato/event_sourcery',
}

Expand Down
4 changes: 2 additions & 2 deletions lib/event_sourcery/aggregate_root.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module EventSourcery
# EventSourcery::AggregateRoot provides a foundation for writing your own aggregate root classes.
# You can use it by including it in your classes, as show in the example code.
#
# Excerpt from {https://github.com/envato/event_sourcery/blob/master/docs/core-concepts.md EventSourcery Core Concepts} on Aggregates follows:
# Excerpt from {https://github.com/envato/event_sourcery/blob/HEAD/docs/core-concepts.md EventSourcery Core Concepts} on Aggregates follows:
# === Aggregates and Command Handling
#
# An aggregate is a cluster of domain objects that can be treated as a single unit.
Expand All @@ -18,7 +18,7 @@ module EventSourcery
# A typical EventSourcery application will have one or more aggregate roots with multiple commands.
#
# The following partial example is taken from the EventSourceryTodoApp.
# Refer a more complete example {https://github.com/envato/event_sourcery_todo_app/blob/master/app/aggregates/todo.rb here}.
# Refer a more complete example {https://github.com/envato/event_sourcery_todo_app/blob/HEAD/app/aggregates/todo.rb here}.
#
# @example
# module EventSourceryTodoApp
Expand Down