Current section

Files

Jump to
continuum mix.exs
Raw

mix.exs

defmodule Continuum.MixProject do
  use Mix.Project

  @version "0.8.5"
  @source_url "https://github.com/Yyeger/Continuum"

  def project do
    [
      app: :continuum,
      version: @version,
      elixir: ">= 1.19.0 and < 1.21.0",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      description: "OTP-native durable execution engine for Elixir.",
      package: package(),
      docs: docs(),
      source_url: @source_url,
      aliases: aliases()
    ]
  end

  def application do
    [
      extra_applications: [:logger],
      mod: {Continuum.Application, []}
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(_), do: ["lib"]

  defp deps do
    [
      {:ecto_sql, dependency_version("~> 3.14", "3.14.0")},
      {:postgrex, dependency_version("~> 0.22.4", "0.22.4")},
      {:jason, dependency_version("~> 1.4.5", "1.4.5")},
      {:telemetry, dependency_version("~> 1.3", "1.3.0")},
      {:phoenix_pubsub, dependency_version("~> 2.1", "2.1.0")},
      {:phoenix, dependency_version(">= 1.7.24 and < 2.0.0", "1.7.24"), optional: true},
      {:phoenix_html, dependency_version("~> 4.0", "4.0.0"), optional: true},
      {:phoenix_live_view, dependency_version(">= 1.2.9 and < 2.0.0", "1.2.9"), optional: true},
      {:oban, dependency_version("~> 2.20", "2.20.0"), optional: true},
      {:bandit, dependency_version("~> 1.12.5", "1.12.5"), only: [:dev, :test], optional: true},
      {:lazy_html, dependency_version(">= 0.1.13", "0.1.13"), only: :test},
      {:stream_data, dependency_version("~> 1.1", "1.1.0"), only: [:dev, :test]},
      {:ex_doc, "~> 0.34", only: :dev, runtime: false},
      {:ex_slop, "~> 0.4.4", only: [:dev, :test], runtime: false}
    ]
  end

  defp dependency_version(supported, minimum) do
    if System.get_env("CONTINUUM_MINIMUM_DEPS") == "1", do: minimum, else: supported
  end

  defp package do
    [
      licenses: ["Apache-2.0"],
      links: %{"GitHub" => @source_url},
      files: ~w(lib priv/static guides mix.exs README.md LICENSE CHANGELOG.md)
    ]
  end

  defp docs do
    [
      main: "Continuum",
      skip_undefined_reference_warnings_on: [
        "README.md",
        "guides/multi-instance.md",
        "guides/observer.md",
        "Continuum",
        "Continuum.Runtime.Context",
        "Continuum.Runtime.Journal",
        "Continuum.VersionRegistry"
      ],
      extras: [
        "README.md",
        "guides/your-first-workflow.md",
        "guides/activities-retries-idempotency.md",
        "guides/idempotency.md",
        "guides/idempotent-ingress.md",
        "guides/retention-pruning.md",
        "guides/schedules.md",
        "guides/multi-instance.md",
        "guides/clustering.md",
        "guides/namespaces.md",
        "guides/signal-contracts.md",
        "guides/replay-safe-logging.md",
        "guides/public-types.md",
        "guides/testing.md",
        "guides/configuration.md",
        "guides/search-and-query.md",
        "guides/sagas.md",
        "guides/child-workflows.md",
        "guides/long-running-workflows.md",
        "guides/patching.md",
        "guides/workflow-versioning.md",
        "guides/operations.md",
        "guides/replay.md",
        "guides/auditing.md",
        "guides/oban-executor.md",
        "guides/observability.md",
        "guides/observer.md",
        "guides/snapshots.md",
        "guides/determinism-rules.md",
        "guides/migrations/MIGRATING_v0_1_to_v0_2.md",
        "guides/migrations/MIGRATING_v0_2_to_v0_3.md",
        "guides/migrations/MIGRATING_v0_3_to_v0_4.md",
        "guides/migrations/MIGRATING_v0_4_to_v0_5.md",
        "guides/migrations/MIGRATING_v0_5_to_v0_5_1.md",
        "guides/migrations/MIGRATING_v0_5_1_to_v0_6.md",
        "guides/migrations/MIGRATING_v0_6_1_to_v0_6_2.md",
        "guides/migrations/MIGRATING_v0_6_4_to_v0_7_0.md",
        "guides/migrations/MIGRATING_v0_7_1_to_v0_7_2.md",
        "guides/migrations/MIGRATING_v0_7_2_to_v0_8.md"
      ],
      groups_for_extras: [
        Guides: ~r/guides\/.*/
      ]
    ]
  end

  defp aliases do
    [
      "test.setup": ["ecto.drop --quiet", "ecto.create --quiet", "ecto.migrate --quiet"],
      "test.cluster": ["cmd env CONTINUUM_CLUSTER_TEST=1 mix test --only cluster test/cluster"],
      "docs.check": ["docs", "run ci/check_doc_links.exs"],
      # The README's crash-recovery demo. `--no-start` so dev/demo/support.exs
      # can load the workflow module before the runtime's version registry and
      # dispatcher come up.
      "continuum.demo": ["run --no-start dev/demo/demo.exs"],
      test: ["ecto.create --quiet", "ecto.migrate --quiet", "test"]
    ]
  end
end