Skip to content

Commit 12f490d

Browse files
committed
Revert "improved documentation on release process; removed changelog"
This reverts commit 722f84b.
1 parent 722f84b commit 12f490d

File tree

5 files changed

+380
-21
lines changed

5 files changed

+380
-21
lines changed

.github/workflows/build.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Check Build
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
package:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Set up Python 3.10
15+
uses: actions/setup-python@v2
16+
with:
17+
python-version: "3.10"
18+
- name: Install build dependencies
19+
run: python -m pip install --upgrade pip wheel twine build
20+
- name: Build package
21+
run: python -m build
22+
- name: Check package
23+
run: twine check --strict dist/*.whl

.github/workflows/release.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,26 @@ on:
55
types: [published]
66

77
jobs:
8-
package_and_release:
8+
release:
9+
# requires that you have put your twine API key in your
10+
# github secrets (see readme for details)
911
runs-on: ubuntu-latest
10-
if: startsWith(github.ref, 'refs/tags/v')
12+
if: contains(github.ref, 'tags')
1113
steps:
12-
- uses: actions/checkout@v3
13-
- name: Set up Python 3.12
14+
- name: Checkout code
15+
uses: actions/checkout@v3
16+
17+
- name: Set up Python 3.10
1418
uses: actions/setup-python@v4
1519
with:
16-
python-version: "3.12"
17-
cache: pip
18-
- name: Install build dependencies
19-
run: python -m pip install --upgrade pip wheel twine build
20-
- name: Build package
21-
run: python -m build
22-
- name: Check package
23-
run: twine check --strict dist/*.whl
20+
python-version: "3.10"
21+
2422
- name: Install hatch
2523
run: pip install hatch
24+
2625
- name: Build project for distribution
2726
run: hatch build
27+
2828
- name: Publish a Python distribution to PyPI
2929
uses: pypa/gh-action-pypi-publish@release/v1
3030
with:

CHANGELOG.md

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,180 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog][],
6+
and this project adheres to [Semantic Versioning][].
7+
8+
[keep a changelog]: https://keepachangelog.com/en/1.0.0/
9+
[semantic versioning]: https://semver.org/spec/v2.0.0.html
10+
11+
## [0.2.9] - tbd
12+
13+
### Fixed
14+
15+
- Transformations of Points and Shapes are now applied before rendering with datashader (#378)
16+
- Fix bug due to `sc.get.obs_df()` returning a different type (#393)
17+
- Allowing instance mismatch between shapes and tables (#396)
18+
- Fix bug when plotting categorical points with datashader (#395)
19+
20+
## [0.2.8] - 2024-11-26
21+
22+
### Changed
23+
24+
- Support for `xarray.DataTree` (which moved from `datatree.DataTree`) (#380)
25+
26+
## [0.2.7] - 2024-10-24
27+
28+
### Added
29+
30+
- The user can now specify `datashader_reduction` to control the rendering behavior (#309)
31+
- Rendering outlines of shapes with datashader works now (#309)
32+
33+
### Fixed
34+
35+
- datashader now uses canvas size = image size which speeds up the rendering (#309)
36+
- datashader now uses the `linear` as interpolation method for colormaps instead of the default `eq_hist` to make it equivalent to matplotlib (#309)
37+
- point sizes of datashader now agree with matplotlib also when dpi != 100 (#309)
38+
- Giving a custom colormap when rendering a multiscale image now works (#586)
39+
40+
## [0.2.6] - 2024-09-04
41+
42+
### Changed
43+
44+
- Lowered RMSE-threshold for plot-based tests from 45 to 15 (#344)
45+
- When subsetting to `groups`, `NA` isn't automatically added to legend (#344)
46+
- When rendering a single image channel, a colorbar is now shown (#346)
47+
- Removed `percentiles_for_norm` parameter (#346)
48+
- Changed `norm` to no longer accept bools, only `mpl.colors.Normalise` or `None` (#346)
49+
50+
### Fixed
51+
52+
- Filtering with `groups` now preserves original cmap (#344)
53+
- Non-selected `groups` are now not shown in `na_color` (#344)
54+
- Several issues associated with `norm` and `colorbar` (#346)
55+
56+
## [0.2.5] - 2024-08-23
57+
58+
### Changed
59+
60+
- Replaced `outline` parameter in `render_labels` with alpha-based logic (#323)
61+
- Lowered RMSE-threshold for plot-based tests from 60 to 45 (#323)
62+
- Removed `preprocessing` (.pp) accessor (#329)
63+
64+
### Fixed
65+
66+
- Minor fixes for several tests as a result of the threshold change (#323)
67+
68+
## [0.2.4] - 2024-08-07
69+
70+
### Added
71+
72+
- Added utils function for 0-transparent cmaps (#302)
73+
74+
### Fixed
75+
76+
- Took RNG out of categorical label test (#306)
77+
- Performance bug when plotting shapes (#298)
78+
- scale parameter was ignored for single-scale images (#301)
79+
- Changes to support for dask-expr (#283)
80+
- Added error handling for non-existent elements (#305)
81+
- Specifying vmin and vmax properly clips image data (#307)
82+
- import bug `get_cmap()` (8fd969c)
83+
84+
## [0.2.3] - 2024-07-03
85+
86+
### Added
87+
88+
- Datashader support for points and shapes (#244)
89+
90+
### Changed
91+
92+
- All parameters are now provided for a single element (#272)
93+
94+
### Fixed
95+
96+
- Fix color assignment for NaN values (#257)
97+
- Zorder of rendering now strictly follows the order of the render_x calls (#244)
98+
99+
## [0.2.2] - 2024-05-02
100+
101+
### Fixed
102+
103+
- Fixed `fill_alpha` ignoring `alpha` channel from custom cmap (#236)
104+
- Fix channel str support (#221)
105+
106+
## [0.2.1] - 2024-03-26
107+
108+
### Minor
109+
110+
- Adjusted GitHub worklows
111+
112+
## [0.2.0] - 2024-03-24
113+
114+
### Added
115+
116+
- Support for plotting multiple tables @melonora
117+
118+
### Fixed
119+
120+
- Several bugfixes, especially for colors and palettes @melonora
121+
122+
## [0.1.0] - 2024-01-17
123+
124+
### Added
125+
126+
- Multiscale image handling: user can specify a scale, else the best scale is selected automatically given the figure size and dpi (#164)
127+
- Large images are automatically rasterized to speed up performance (#164)
128+
- Added better error message for mismatch in cs and ax number (#185)
129+
- Beter test coverage for correct plotting of elements after transformation (#198)
130+
- Can now stack render commands (#190, #192)
131+
- The `color` argument in render_shapes/points now accepts actual colors as well (#199)
132+
- Input arguments are now evaulated for their types in basic.py (#199)
133+
134+
### Fixed
135+
136+
- Now dropping index when plotting shapes after spatial query (#177)
137+
- Points are now being correctly rotated (#198)
138+
- User can now pass Colormap objects to the cmap argument in render_images. When only one cmap is given for 3 channels, it is now applied to each channel (#188, #194)
139+
140+
## [0.0.6] - 2023-11-06
141+
142+
### Added
143+
144+
- Pushed `get_extent` functionality upstream to `spatialdata` (#162)
145+
146+
## [0.0.5] - 2023-10-02
147+
148+
### Added
149+
150+
- Can now scale shapes (#152)
151+
- Can now plot columns from GeoDataFrame (#149)
152+
153+
### Fixed
154+
155+
- Multipolygons are now handled correctly (#93)
156+
- Legend order is now deterministic (#143)
157+
- Images no longer normalised by default (#150)
158+
- Filtering of shapes and points using the `groups` argument is now possible, coloring by palette and cmap arguments works for shapes and points (#153)
159+
- Colorbar no longer autoscales to [0, 1] (#155)
160+
- Plotting shapes after a spatial query is now possible (#163)
161+
162+
## [0.0.4] - 2023-08-11
163+
164+
### Fixed
165+
166+
- Multi-scale images/labels are now correctly substituted and the action is logged (#131).
167+
- Empty geometries among the shapes can be handeled (#133).
168+
- `outline_width` parameter in render_shapes is now a float that actually determines the line width (#139).
169+
170+
## [0.0.2] - 2023-06-25
171+
172+
### Fixed
173+
174+
- Multiple bugfixes of which I didn't keep track of.
175+
176+
## [0.0.1] - 2023-04-04
177+
178+
### Added
179+
180+
- Initial release of `spatialdata-plot` with support for `images`, `labels`, `points` and `shapes`.

docs/changelog.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# Changelog
1+
```{include} ../CHANGELOG.md
22
3-
Please refer directly to the [Releases](https://github.com/scverse/spatialdata-plot/releases) section on GitHub, where you can find curated release notes for each release.
4-
For developers, please consult the [contributing guide](https://github.com/scverse/spatialdata/blob/main/docs/contributing.md), which explains how to keep release notes are up-to-date at each release.
3+
```

0 commit comments

Comments
 (0)