Skip to content

Commit 436691e

Browse files
authored
Release prep v0.6.0 (#150)
* update CHANGELOG.md * update docs/source/conf.py * update version string in pyproject.toml * update maintainer per PGad req * add migration doc section to readme * pete claims non-authorship
1 parent 931f4fd commit 436691e

File tree

4 files changed

+35
-7
lines changed

4 files changed

+35
-7
lines changed

CHANGELOG.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
66
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.6.0]
99

1010
### ⚠️ Breaking Change
1111

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

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

119120
Initial release.
120121

121-
[unreleased]: <https://github.com/stac-utils/stac-task/compare/v0.5.1...main>
122+
[unreleased]: <https://github.com/stac-utils/stac-task/compare/v0.6.0...main>
123+
[0.6.0]: <https://github.com/stac-utils/stac-task/compare/v0.5.1...0.6.0>
122124
[0.5.1]: <https://github.com/stac-utils/stac-task/compare/v0.5.0...v0.5.1>
123125
[0.5.0]: <https://github.com/stac-utils/stac-task/compare/v0.4.2...v0.5.0>
124126
[v0.4.2]: <https://github.com/stac-utils/stac-task/compare/v0.4.1...v0.4.2>

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,32 @@ Migration of these various parameters to `DownloadConfig` are as follows:
242242
- `absolute_path`: none. To create or retrieve the Asset hrefs as absolute paths, use either
243243
`Item#make_all_asset_hrefs_absolute()` or `Asset#get_absolute_href()`
244244

245+
### 0.5.x -> 0.6.0
246+
247+
Previously, the `validate` method was a _classmethod_, validating the payload
248+
argument passed. This has now been made an instance method, which validates
249+
the `self._payload` copy of the payload, from which the `Task` instance is
250+
constructed. This is behaviorally the same, in that construction will fail if
251+
validation fails, but allows implementers to utilize the instance method's
252+
convenience functions.
253+
254+
Previous implementations of `validate` would have been similar to this:
255+
256+
```python
257+
@classmethod
258+
def validate(payload: dict[str, Any]) -> bool:
259+
# Check The Things™
260+
return isinstance(payload, dict)
261+
```
262+
263+
And will now need to be updated to this form:
264+
265+
```python
266+
def validate(self) -> bool:
267+
# Check The Things™
268+
return isinstance(self._payload, dict)
269+
```
270+
245271
## Development
246272

247273
Clone, install in editable mode with development requirements, and install the **pre-commit** hooks:

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
project = "STAC Task"
1313
copyright = "2021, Element 84, Inc."
1414

15-
release = "0.5"
16-
version = "0.5.1"
15+
release = "0.6"
16+
version = "0.6.0"
1717

1818
# -- General configuration
1919

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[project]
22
name = "stactask"
3-
version = "0.5.1"
3+
version = "0.6.0"
44
authors = [{ name = "Matthew Hanson", email = "[email protected]" }]
5-
maintainers = [{ name = "Pete Gadomski", email = "pete.gadomski@gmail.com" }]
5+
maintainers = [{ name = "Ian Cooke", email = "ircwaves@gmail.com" }]
66
description = "Class interface for running custom algorithms and workflows on STAC Items"
77
readme = "README.md"
88
requires-python = ">=3.9"

0 commit comments

Comments
 (0)