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

Release prep v0.6.0 #150

Merged
merged 6 commits into from
Sep 19, 2024
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
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [0.6.0]

### ⚠️ Breaking Change

- ([#147](https://github.com/stac-utils/stac-task/pull/147)) Moved `Task.validate` from class method to instance method, availing
- ([#147](https://github.com/stac-utils/stac-task/pull/147)) Moved
`Task.validate` from class method to instance method, availing
implementers of other instance convenience methods (i.e. `self.parameters`).

## [0.5.1] - 2024-05-23
Expand Down Expand Up @@ -118,7 +119,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

Initial release.

[unreleased]: <https://github.com/stac-utils/stac-task/compare/v0.5.1...main>
[unreleased]: <https://github.com/stac-utils/stac-task/compare/v0.6.0...main>
[0.6.0]: <https://github.com/stac-utils/stac-task/compare/v0.5.1...0.6.0>
[0.5.1]: <https://github.com/stac-utils/stac-task/compare/v0.5.0...v0.5.1>
[0.5.0]: <https://github.com/stac-utils/stac-task/compare/v0.4.2...v0.5.0>
[v0.4.2]: <https://github.com/stac-utils/stac-task/compare/v0.4.1...v0.4.2>
Expand Down
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,32 @@ Migration of these various parameters to `DownloadConfig` are as follows:
- `absolute_path`: none. To create or retrieve the Asset hrefs as absolute paths, use either
`Item#make_all_asset_hrefs_absolute()` or `Asset#get_absolute_href()`

### 0.5.x -> 0.6.0

Previously, the `validate` method was a _classmethod_, validating the payload
argument passed. This has now been made an instance method, which validates
the `self._payload` copy of the payload, from which the `Task` instance is
constructed. This is behaviorally the same, in that construction will fail if
validation fails, but allows implementers to utilize the instance method's
convenience functions.

Previous implementations of `validate` would have been similar to this:

```python
@classmethod
def validate(payload: dict[str, Any]) -> bool:
# Check The Things™
return isinstance(payload, dict)
```

And will now need to be updated to this form:

```python
def validate(self) -> bool:
# Check The Things™
return isinstance(self._payload, dict)
```

## Development

Clone, install in editable mode with development requirements, and install the **pre-commit** hooks:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
project = "STAC Task"
copyright = "2021, Element 84, Inc."

release = "0.5"
version = "0.5.1"
release = "0.6"
version = "0.6.0"

# -- General configuration

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[project]
name = "stactask"
version = "0.5.1"
version = "0.6.0"
authors = [{ name = "Matthew Hanson", email = "matt.a.hanson@gmail.com" }]
maintainers = [{ name = "Pete Gadomski", email = "pete.gadomski@gmail.com" }]
maintainers = [{ name = "Ian Cooke", email = "ircwaves@gmail.com" }]
description = "Class interface for running custom algorithms and workflows on STAC Items"
readme = "README.md"
requires-python = ">=3.9"
Expand Down