Packages
oban
2.23.0
2.23.0
2.22.1
2.22.0
2.21.1
2.21.0
2.20.3
2.20.2
2.20.1
2.20.0
2.19.4
2.19.3
2.19.2
2.19.1
2.19.0
2.18.3
2.18.2
2.18.1
2.18.0
2.17.12
2.17.11
2.17.10
2.17.9
2.17.8
2.17.7
2.17.6
2.17.5
2.17.4
2.17.3
2.17.2
2.17.1
2.17.0
2.16.3
2.16.2
2.16.1
2.16.0
2.15.4
2.15.3
2.15.2
2.15.1
2.15.0
2.14.2
2.14.1
2.14.0
2.13.6
2.13.5
2.13.4
2.13.3
2.13.2
2.13.1
2.13.0
2.12.1
2.12.0
2.11.3
2.11.2
2.11.1
2.11.0
2.10.1
2.10.0
retired
2.9.2
2.9.1
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.1
2.6.0
2.5.0
2.4.3
2.4.2
2.4.1
2.4.0
2.3.4
2.3.3
2.3.2
2.3.1
2.3.0
2.2.0
2.1.0
2.0.0
2.0.0-rc.3
2.0.0-rc.2
2.0.0-rc.1
2.0.0-rc.0
1.2.0
1.1.0
1.0.0
1.0.0-rc.2
1.0.0-rc.1
0.12.1
0.12.0
0.11.1
0.11.0
0.10.1
0.10.0
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
Robust job processing, backed by modern PostgreSQL, SQLite3, and MySQL.
Current section
Files
Jump to
Current section
Files
mix.exs
defmodule Oban.MixProject do
use Mix.Project
@source_url "https://github.com/oban-bg/oban"
@version "2.23.0"
def project do
[
app: :oban,
version: @version,
elixir: "~> 1.15",
elixirc_paths: elixirc_paths(Mix.env()),
start_permanent: Mix.env() == :prod,
deps: deps(),
aliases: aliases(),
# Hex
package: package(),
description: """
Robust job processing, backed by modern PostgreSQL, SQLite3, and MySQL.
""",
# Dialyzer
dialyzer: [
plt_add_apps: [:ex_unit, :mix, :postgrex],
plt_core_path: "_build/#{Mix.env()}",
flags: [:error_handling, :missing_return, :no_opaque, :underspecs]
],
# Docs
name: "Oban",
docs: [
main: "Oban",
api_reference: false,
logo: "assets/oban-logo.svg",
assets: %{"assets" => "assets"},
source_ref: "v#{@version}",
source_url: @source_url,
extra_section: "GUIDES",
formatters: ["html"],
extras: extras(),
groups_for_extras: groups_for_extras(),
groups_for_modules: groups_for_modules(),
skip_undefined_reference_warnings_on: ["CHANGELOG.md"]
]
]
end
def cli do
[preferred_envs: [bench: :test, "test.ci": :test, "test.reset": :test, "test.setup": :test]]
end
def application do
[
mod: {Oban.Application, []},
extra_applications: [:logger]
]
end
defp elixirc_paths(:test), do: ["lib", "test/support"]
defp elixirc_paths(_env), do: ["lib"]
defp extras do
[
# Introduction
"guides/introduction/installation.md",
"guides/introduction/ready_for_production.md",
# Learning
"guides/learning/defining_queues.md",
"guides/learning/job_lifecycle.md",
"guides/learning/scheduling_jobs.md",
"guides/learning/periodic_jobs.md",
"guides/learning/unique_jobs.md",
"guides/learning/operational_maintenance.md",
"guides/learning/instrumentation.md",
"guides/learning/error_handling.md",
"guides/learning/clustering.md",
"guides/learning/isolation.md",
# Advanced
"guides/advanced/writing_plugins.md",
"guides/advanced/release_configuration.md",
"guides/advanced/scaling.md",
"guides/advanced/troubleshooting.md",
# Upgrading
"guides/upgrading/v2.0.md",
"guides/upgrading/v2.6.md",
"guides/upgrading/v2.11.md",
"guides/upgrading/v2.12.md",
"guides/upgrading/v2.14.md",
"guides/upgrading/v2.17.md",
"guides/upgrading/v2.20.md",
"guides/upgrading/v2.21.md",
# Recipes
"guides/recipes/recursive-jobs.md",
"guides/recipes/reliable-scheduling.md",
"guides/recipes/reporting-progress.md",
"guides/recipes/expected-failures.md",
"guides/recipes/splitting-queues.md",
"guides/recipes/migrating-from-other-languages.md",
# Testing
"guides/testing/testing.md",
"guides/testing/testing_workers.md",
"guides/testing/testing_queues.md",
"guides/testing/testing_config.md",
"CHANGELOG.md": [title: "Changelog"]
]
end
defp groups_for_extras do
[
External: ~r{https:},
Introduction: ~r{guides/introduction/[^\/]+\.md},
Learning: ~r{guides/learning/[^\/]+\.md},
Advanced: ~r{guides/advanced/[^\/]+\.md},
Recipes: ~r{guides/recipes/.?},
Testing: ~r{guides/testing/.?},
Upgrading: ~r{guides/upgrading/.*}
]
end
defp groups_for_modules do
[
Plugins: [
Oban.Plugin,
Oban.Plugins.Cron,
Oban.Plugins.Lifeline,
Oban.Plugins.Pruner,
Oban.Plugins.Reindexer
],
Extending: [
Oban.Config,
Oban.Registry,
Oban.Repo,
Oban.Telemetry
],
Notifiers: [
Oban.Notifier,
Oban.Notifiers.Postgres,
Oban.Notifiers.PG
],
Peers: [
Oban.Peer,
Oban.Peers.Database,
Oban.Peers.Global
],
Engines: [
Oban.Engine,
Oban.Engines.Basic,
Oban.Engines.Dolphin,
Oban.Engines.Inline,
Oban.Engines.Lite
]
]
end
defp package do
[
maintainers: ["Parker Selbert"],
licenses: ["Apache-2.0"],
files: ~w(lib .formatter.exs mix.exs README* CHANGELOG* LICENSE*),
links: %{
Website: "https://oban.pro",
Changelog: "#{@source_url}/blob/main/CHANGELOG.md",
GitHub: @source_url
}
]
end
defp deps do
[
{:ecto_sql, "~> 3.10"},
{:telemetry, "~> 1.3"},
# Optional
{:ecto_sqlite3, "~> 0.9", optional: true},
{:jason, "~> 1.1", optional: true},
{:igniter, "~> 0.5", optional: true},
{:myxql, "~> 0.7", optional: true},
{:postgrex, "~> 0.20", optional: true},
# Test and Dev
{:stream_data, "~> 1.0", only: [:test, :dev]},
{:tz, "~> 0.24", only: [:test, :dev]},
{:benchee, "~> 1.4", only: [:test, :dev], runtime: false},
{:credo, "~> 1.7", only: [:test, :dev], runtime: false},
{:dialyxir, "~> 1.4", only: [:test, :dev], runtime: false},
{:ex_doc, "~> 0.38", only: [:test, :dev], runtime: false},
{:makeup_diff, "~> 0.1", only: [:test, :dev], runtime: false}
]
end
defp aliases do
[
bench: "run bench/bench_helper.exs",
release: [
"cmd git tag v#{@version}",
"cmd git push",
"cmd git push --tags",
"hex.publish --yes"
],
"test.reset": ["ecto.drop --quiet", "test.setup"],
"test.setup": ["ecto.create --quiet", "ecto.migrate --quiet"],
"test.ci": [
"format --check-formatted",
"deps.unlock --check-unused",
"credo --strict",
"test --raise",
"dialyzer"
]
]
end
end