cliff.toml

[remote.github]
owner = "danielgafni"
repo = "dagster-ray"

[bump]
features_always_bump_minor = false
breaking_always_bump_major = false

[git]
commit_preprocessors = [
  { pattern = '^\((\w+)\)!:', replace = "($1):" },
  # Map legacy emoji-prefixed commits to conventional commits
  { pattern = '^:sparkles: ', replace = "feat: " },
  { pattern = '^:bug: ', replace = "fix: " },
  { pattern = '^:book: ', replace = "docs: " },
  { pattern = '^:art: ', replace = "refactor: " },
  { pattern = '^:wrench: ', replace = "feat: " },
  { pattern = '^:zap: ', replace = "perf: " },
  { pattern = '^:robot: ', replace = "ci: " },
  { pattern = '^:bomb: ', replace = "feat!: " },
  # Map other legacy prefixes to conventional commits
  { pattern = '^\[docs\] ', replace = "docs: " },
  { pattern = '^add support for', replace = "feat: add support for" },
  # Strip PR references from messages (handled in template with author links)
  { pattern = ' \(#\d+\)', replace = "" },
]
commit_parsers = [
  { message = "^.*!:", group = "<0>### :bomb: Breaking" },
  { message = "^feat", group = "<1>### :sparkles: Features" },
  { message = "^fix", group = "<2>### :bug: Bug Fixes" },
  { message = "^docs", group = "<3>### :book: Docs" },
  { message = "^perf", group = "<4>### :zap: Performance" },
  { message = "^refactor", group = "<5>### :hammer_and_wrench: Other Improvements" },
  { message = "^chore", group = "<5>### :hammer_and_wrench: Other Improvements" },
  { message = "^ci", group = "<5>### :hammer_and_wrench: Other Improvements" },
  { message = "^build", group = "<5>### :hammer_and_wrench: Other Improvements" },
  { message = "^test", group = "<5>### :hammer_and_wrench: Other Improvements" },
  { message = "^style", group = "<5>### :hammer_and_wrench: Other Improvements" },
  { message = "^.*", skip = true },
]
ignore_tags = "v0\\.0\\."
# Tags whose changelog entries are hardcoded in the footer; update regex when adding new footer entries
skip_tags = "v0\\.[1-3]\\.|v0\\.4\\.[0-2]"
sort_commits = "newest"

[changelog]
header = """
# Changelog

All notable user-facing changes to `dagster-ray` will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

"""
body = """
## {{ version | default(value="Unreleased") }}{% if timestamp %} ({{ timestamp | date(format="%d-%m-%Y") }}){% endif %}
{% if message %}
{{ message }}

{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
{{ group | striptags | trim }}
{% for commit in commits %}
- {{ commit.message | split(pat="\n") | first | trim }}\
    {% if commit.remote.pr_number %} ([#{{ commit.remote.pr_number }}](https://github.com/danielgafni/dagster-ray/pull/{{ commit.remote.pr_number }}){% if commit.remote.username %} by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}){% endif %})
{%- elif commit.remote.username %} (by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}))
{%- endif %}
{%- endfor %}
{% endfor %}\
{%- set new_contributors = github.contributors | filter(attribute="is_first_time", value=true) -%}
{%- set_global new_contribs_count = 0 -%}
{%- set existing = "danielgafni,JosefNagelschmidt,cornettew,geoHeil,serriaguirregaray,dependabot[bot],github-actions[bot],renovate[bot]" -%}
{%- for contributor in new_contributors -%}
{%- if not existing is containing(contributor.username) -%}
{%- set_global new_contribs_count = new_contribs_count + 1 -%}
{%- endif -%}
{%- endfor -%}
{% if new_contribs_count > 0 %}
### :heart: New Contributors
{% for contributor in new_contributors -%}
{%- if not existing is containing(contributor.username) -%}
{%- set_global first_pr = contributor.pr_number -%}
{%- for commit in commits -%}
{%- if commit.remote.username == contributor.username and commit.remote.pr_number -%}
{%- set_global first_pr = commit.remote.pr_number -%}
{%- endif -%}
{%- endfor %}
- [@{{ contributor.username }}](https://github.com/{{ contributor.username }}) made their first contribution in [#{{ first_pr }}](https://github.com/danielgafni/dagster-ray/pull/{{ first_pr }})
{%- endif -%}
{%- endfor %}
{% endif %}
"""
footer = """

## 0.4.2 (20-02-2026)

### Added

- `RayResource` now has new lifecycle hook methods for customizing startup messages (and potentially doing something else):
    - `on_create`
    - `on_ready`
    - `on_connect`
    - `on_cleanup`

### Fixes

- fixed duplicated startup log message for `LocalRay`
- fixed the top-level `env_vars` Dagster config field not taking effect for `KubeRayInteractiveJob`

## 0.4.1 (25-01-2026)

### Added

- `RayCluster`'s head pod logs are now displayed on startup timeout or failure

### Fixes

- Prevent the `RayCluster` cleanup sensor from targeting clusters with `.metadata.ownerReferences` set.
- `address` config value can now be omitted for `ray_executor`, making it use Ray's default cluster address resolution. Thanks @cornettew!
- Fixed race condition with cluster sharing: previously multiple steps running in parallel could create different `RayCluster` instances at the same time (that were supposed to be shared). `dagster-ray` now uses Kubernetes [Lease](https://kubernetes.io/docs/concepts/architecture/leases/)-based leader election to coordinate shared cluster creation, which guarantees that only one of the running steps creates the shared `RayCluster`.
- `runtimeEnvYAML` now has all strings fully quoted which fixes passing values such as `1e-5` as `runtime_env` values. Thanks @JosefNagelschmidt!
- `ray_address` is now optional for `RunLauncherConfig`. Thanks @cornettew!

## 0.4.0 (10-10-2025)

This release introduces a new feature that is very useful in dev environments: **Cluster Sharing**. Cluster sharing allows reusing existing `RayCluster` resources created by previous Dagster steps. It's implemented for `KubeRayCluster` Dagster resource. This feature enables faster iteration speed and reduced infrastructure costs (at the expense of job isolation). Therefore `KubeRayCluster` is now recommended over `KubeRayInteractiveJob` for use in **dev** environments.

Learn more in [Cluster Sharing docs](tutorial/kuberay.md/#cluster-sharing).

### Added
- `KubeRayCluster.cluster_sharing` parameter that controls cluster sharing behavior.
- `dagster_ray.kuberay.sensors.cleanup_expired_kuberay_clusters` sensor that cleans up expired clusters (both shared and non-shared). Learn more in [docs](api/kuberay.md#dagster_ray.kuberay.sensors.cleanup_expired_kuberay_clusters).
- `dagster-ray` entry now appears in the Dagster libraries list in the web UI.

### Changed
- [:bomb: breaking] - removed `cleanup_kuberay_clusters_op` and other associated definitions in favor of `dagster_ray.kuberay.sensors.cleanup_expired_kuberay_clusters` sensor that is more flexible.

## 0.3.1 (02-10-2025)

### Added
- `failure_tolerance_timeout` configuration parameter for `KubeRayInteractiveJob` and `KubeRayCluster`. It can be set to a positive value to give the cluster some time to transition out of `failed` state (which can be transient in some scenarios) before raising an error.

### Fixes
- ensure both `.head.serviceIP` and `.head.serviceName` are set on the `RayCluster` while waiting for cluster readiness.

## 0.3.0 (19-09-2025)

This release includes massive docs improvements and drops support for Python 3.9.

### Changes

- [:bomb: breaking] dropped Python 3.9 support (EOL October 2025).
- [internal] most of the general, backend-agnostic code has been moved to `dagster_ray.core` (top-level imports still work).

## 0.2.1 (18-09-2025)

### Fixes

- Fixed broken wheel on PyPI.

## 0.2.0 (18-09-2025)

### Changed
- `KubeRayInteractiveJob.deletion_strategy` now defaults to `DeleteCluster` for both successful and failed executions. This is a reasonable default for the use case.
- `KubeRayInteractiveJob.ttl_seconds_after_finished` now defaults to `600` seconds.
- `KubeRayCluster.lifecycle.cleanup` now defaults to `always`.
- [:bomb: breaking] `RayJob` and `RayCluster` clients and resources Kubernetes init parameters have been renamed to `kube_config` and `kube_context`.

### Added
- `enable_legacy_debugger` configuration parameter to subclasses of `RayResource`
- `on_exception` option for `lifecycle.cleanup` policy. It's triggered during resource setup/cleanup (including `KeyboardInterrupt`), but not by user `@op`/`@asset` code.
- `KubeRayInteractiveJob` now respects `lifecycle.cleanup`. It defaults to `on_exception`. Users are advised to rely on built-in `RayJob` cleanup mechanisms, such as `ttlSecondsAfterFinished` and `deletionStrategy`.

### Fixes
- removed `ignore_reinit_error` from `RayResource` init options: it's potentially dangerous, for example in case the user has accidentally connected to another Ray cluster (including local ray) before initializing the resource.

## 0.1.0 (05-09-2025)

### Changed
- [:bomb: breaking] `RayResource`: top-level `skip_init` and `skip_setup` configuration parameters have been removed. The `lifecycle` field is the new way of configuring steps performed during resource initialization. `KubeRayCluster`'s `skip_cleanup` has been moved to `lifecycle` as well.
- [:bomb: breaking] injected `dagster.io/run_id` Kubernetes label has been renamed to `dagster/run-id`. Keys starting with `dagster.io/` have been converted to `dagster/` to match how `dagster-k8s` does it.
- [:bomb: breaking] `dagster_ray.kuberay` Configurations have been unified with KubeRay APIs.
- `dagster-ray` now populates Kubernetes labels with more values (including some useful Dagster Cloud values such as `git-sha`).

### Added
- `KubeRayInteractiveJob` -- a resource that utilizes the new `InteractiveMode` for `RayJob`. It can be used to connect to Ray in Client mode -- like `KubeRayCluster` -- but gives access to `RayJob` features, such as automatic cleanup (`ttlSecondsAfterFinished`), retries (`backoffLimit`) and timeouts (`activeDeadlineSeconds`).
- `RayResource` setup lifecycle has been overhauled: resources now has an `actions` parameter with 3 configuration options: `create`, `wait` and `connect`. The user can disable them and run `.create()`, `.wait()` and `.connect()` manually if needed.
"""
postprocessors = [
  { pattern = 'danielgafni/dagster-ray/blob/master/', replace = "danielgafni/dagster-ray/blob/main/" },
]
trim = false