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

Prep release: update release notes #3406

Merged
merged 4 commits into from
Dec 12, 2023
Merged
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
27 changes: 20 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Major features and improvements
* Dropped Python 3.7 support.
* Introduced project tools and example to the `kedro new` CLI flow.
* [Introduced project tools and example to the `kedro new` CLI flow](docs/source/get_started/new_project.md#project-tools).
* The new spaceflights starters, `spaceflights-pandas`, `spaceflights-pandas-viz`, `spaceflights-pyspark`, and `spaceflights-pyspark-viz` can be used with the `kedro new` command with the `--starter` flag.
* Added the `--conf-source` option to `%reload_kedro`, allowing users to specify a source for project configuration.
* Added the functionality to choose a merging strategy for config files loaded with `OmegaConfigLoader`.
* [Added the functionality to choose a merging strategy for config files loaded with `OmegaConfigLoader`](docs/source/configuration/advanced_configuration.md#how-to-change-the-merge-strategy-used-by-omegaconfigloader).
* Modified the mechanism of importing datasets, raise more explicit error when dependencies are missing.
* Added validation for configuration file used to override run commands via the CLI.
* Moved the default environment `base` and `local` from config loader to `_ProjectSettings`. This enables the use of config loader as a standalone class without affecting existing Kedro Framework users.
Expand Down Expand Up @@ -58,13 +58,30 @@
* The default project template now has one `pyproject.toml` at the root of the project (containing both the packaging metadata and the Kedro build config).
* The `requirements.txt` in the default project template moved to the root of the project as well (hence dependencies are now installed with `pip install -r requirements.txt` instead of `pip install -r src/requirements.txt`).
* The `spaceflights` starter has been renamed to `spaceflights-pandas`.
* The starters `pandas-iris`, `pyspark-iris`, `pyspark`, and `standalone-datacatalog` have been archived.

## Migration guide from Kedro 0.18.* to 0.19.*
* Removed the custom Kedro syntax for `--params`, use the OmegaConf syntax instead by replacing `:` with `=`.
* Removed the `create_default_data_set()` method in the `Runner`. To overwrite the default dataset creation, use the new `Runner` class argument `extra_dataset_patterns` instead.
* Removed `project_version` in `pyproject.toml` please use `kedro_init_version` instead.

Check warning on line 66 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L66

[Kedro.words] Use '' instead of 'please'.
Raw output
{"message": "[Kedro.words] Use '' instead of 'please'.", "location": {"path": "RELEASE.md", "range": {"start": {"line": 66, "column": 49}}}, "severity": "WARNING"}

### Datasets
* If you use `APIDataSet`, move all `requests` specific arguments (e.g. `params`, `headers`), except for `url` and `method`, to under `load_args`.
* Using the `layer` attribute at the top level is removed. Please move `layer` inside the `metadata` -> `kedro-viz` attributes.
* Renamed dataset and error classes, in accordance with the [Kedro lexicon](https://github.com/kedro-org/kedro/wiki/Kedro-documentation-style-guide#kedro-lexicon). Dataset classes ending with "DataSet" and error classes starting with "DataSet" are removed. Note that all of the below classes are also importable from `kedro.io`; only the module where they are defined is listed as the location.

Check warning on line 71 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L71

[Kedro.toowordy] 'in accordance with' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'in accordance with' is too wordy", "location": {"path": "RELEASE.md", "range": {"start": {"line": 71, "column": 38}}}, "severity": "WARNING"}

Check warning on line 71 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L71

[Kedro.words] Use '**Note**:' instead of 'Note that'.
Raw output
{"message": "[Kedro.words] Use '**Note**:' instead of 'Note that'.", "location": {"path": "RELEASE.md", "range": {"start": {"line": 71, "column": 258}}}, "severity": "WARNING"}

Check warning on line 71 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L71

[Kedro.toowordy] 'all of' is too wordy
Raw output
{"message": "[Kedro.toowordy] 'all of' is too wordy", "location": {"path": "RELEASE.md", "range": {"start": {"line": 71, "column": 268}}}, "severity": "WARNING"}

Check warning on line 71 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L71

[Kedro.weaselwords] 'only' is a weasel word!
Raw output
{"message": "[Kedro.weaselwords] 'only' is a weasel word!", "location": {"path": "RELEASE.md", "range": {"start": {"line": 71, "column": 330}}}, "severity": "WARNING"}

| Type | Removed Alias | Location |
| --------------------------- | --------------------------- | ------------------------------ |
| `AbstractDataset` | `AbstractDataSet` | `kedro.io.core` |
| `AbstractVersionedDataset` | `AbstractVersionedDataSet` | `kedro.io.core` |
| `CachedDataset` | `CachedDataSet` | `kedro.io.cached_dataset` |
| `LambdaDataset` | `LambdaDataSet` | `kedro.io.lambda_dataset` |
| `MemoryDataset` | `MemoryDataSet` | `kedro.io.memory_dataset` |
| `DatasetError` | `DataSetError` | `kedro.io.core` |
| `DatasetAlreadyExistsError` | `DataSetAlreadyExistsError` | `kedro.io.core` |
| `DatasetNotFoundError` | `DataSetNotFoundError` | `kedro.io.core` |
* All other dataset classes are removed from the core Kedro repository (`kedro.extras.datasets`). Install and import them from the [`kedro-datasets`](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-datasets) package instead.

### Logging
`logging.yml` is now independent of Kedro's run environment and only used if `KEDRO_LOGGING_CONFIG` is set to point to it.

Expand All @@ -75,6 +92,7 @@
* [Laíza Milena Scheid Parizotto](https://github.com/laizaparizotto) 🎃
* [Mustapha Abdullahi](https://github.com/mustious)
* [Adam Kells](https://github.com/adamkells)
* [Ajay Gonepuri](https://github.com/HKABIG)

Check warning on line 95 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L95

[Kedro.Spellings] Did you really mean 'Ajay'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'Ajay'?", "location": {"path": "RELEASE.md", "range": {"start": {"line": 95, "column": 4}}}, "severity": "WARNING"}

Check warning on line 95 in RELEASE.md

View workflow job for this annotation

GitHub Actions / vale

[vale] RELEASE.md#L95

[Kedro.Spellings] Did you really mean 'Gonepuri'?
Raw output
{"message": "[Kedro.Spellings] Did you really mean 'Gonepuri'?", "location": {"path": "RELEASE.md", "range": {"start": {"line": 95, "column": 9}}}, "severity": "WARNING"}

# Release 0.18.14

Expand Down Expand Up @@ -256,8 +274,6 @@
* [tomasvanpottelbergh](https://github.com/tomasvanpottelbergh)
* [https://github.com/debugger24](https://github.com/debugger24)

## Upcoming deprecations for Kedro 0.19.0

# Release 0.18.8

## Major features and improvements
Expand Down Expand Up @@ -502,9 +518,6 @@
## Upcoming deprecations for Kedro 0.19.0
* `kedro docs` will be removed in 0.19.0.

## Upcoming deprecations for Kedro 0.19.0
* `kedro docs` will be removed in 0.19.0.


# Release 0.18.0

Expand Down