Skip to content

Commit

Permalink
Add changelog entry and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
@simonrw
simonrw committed Dec 19, 2022
1 parent dcf2436 commit 37e251b
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 56 deletions.
104 changes: 57 additions & 47 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,33 +6,42 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a

## [Unreleased]
### Added
### Changed
### Removed

## [0.21.0]
### Added

* The abillity to create a `FitsFile` struct from a `fitsio_sys::fitsfile` pointer [#195](https://github.com/simonrw/rust-fitsio/pull/195)
* Support for boolean header card values
* `fitsio-sys` (whichever feature is used) is exposed as `fitsio::sys` to make sure that only one crate that links to the system library exists [#195](https://github.com/simonrw/rust-fitsio/pull/174)

### Changed

* **BREAKING CHANGE** the previously public field `filename` on `FitsFile` has been removed, since:
* it is now optional,
* it is not used internally for much, and
* it is state that does not need to be part of `fitsio`. [#195](https://github.com/simonrw/rust-fitsio/pull/174)
* Some more types are deriving `Eq` thanks to a clippy lint
* Fixed broken tests on m1 macos [#174](https://github.com/mindriot101/rust-fitsio/pull/174)
* Minimum cfitsio version of 3.37 specified for compilation [#184](https://github.com/mindriot101/rust-fitsio/pull/184)

### Removed
* Fixed broken tests on m1 macos [#174](https://github.com/simonrw/rust-fitsio/pull/174)
* Minimum cfitsio version of 3.37 specified for compilation [#184](https://github.com/simonrw/rust-fitsio/pull/184)

## [0.20.0]
### Added

* Initial support for windows msys2 [#150](https://github.com/mindriot101/rust-fitsio/pull/150)
* Initial support for windows msys2 [#150](https://github.com/simonrw/rust-fitsio/pull/150)

### Changed

* Specify version dependencies more specifically which should make installations more reliable, see [this post](https://users.rust-lang.org/t/psa-please-specify-precise-dependency-versions-in-cargo-toml/71277/9) [#151](https://github.com/mindriot101/rust-fitsio/pull/151)
* Specify version dependencies more specifically which should make installations more reliable, see [this post](https://users.rust-lang.org/t/psa-please-specify-precise-dependency-versions-in-cargo-toml/71277/9) [#151](https://github.com/simonrw/rust-fitsio/pull/151)
* Pin `ndarray` against versions 0.15.*. This prevents downstream users from
having interoperability problems when `ndarray` updates to 0.16.0.

## [0.19.0]
### Added

* Added support for 16 bit images and tables thanks @emaadparacha
[#148](https://github.com/mindriot101/rust-fitsio/pull/148).
[#148](https://github.com/simonrw/rust-fitsio/pull/148).

### Changed

Expand All @@ -56,7 +65,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
* Added support for compiling `cfitsio` from source rather than using the
bundled version. This requires the installer needing to include the
dependencies that are required for installing `cfitsio`, namely `make` and
`gcc`, thanks @cjordan. [#130](https://github.com/mindriot101/rust-fitsio/pull/130)
`gcc`, thanks @cjordan. [#130](https://github.com/simonrw/rust-fitsio/pull/130)

### Changed

Expand All @@ -71,7 +80,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
* (`fitsio`) expose the HDU number (`number`) in the `FitsHdu` struct
* (`fitsio`) handle the 'X' fits column data type. This may not match the
behaviour with cfitsio, but that behaviour is also seemingly complicated and
suboptimal; see [#122](https://github.com/mindriot101/rust-fitsio/pull/122)
suboptimal; see [#122](https://github.com/simonrw/rust-fitsio/pull/122)
for discussion.

### Changed
Expand All @@ -96,46 +105,46 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
### Added

* (`fitsio`) add boolean column type
* (`fitsio`) add threadsafe version of a `FitsFile` [#99](https://github.com/mindriot101/rust-fitsio/pull/99)
* (`fitsio`) add benchmarking [#98](https://github.com/mindriot101/rust-fitsio/pull/98)
* (`fitsio`) add threadsafe version of a `FitsFile` [#99](https://github.com/simonrw/rust-fitsio/pull/99)
* (`fitsio`) add benchmarking [#98](https://github.com/simonrw/rust-fitsio/pull/98)
* (`fitsio`) add support for writing all integer header keys

### Changed

* (`fitsio`) fix errors with the system allocator, ensuring the package will run on the latest nightly and beta compilers [#100](https://github.com/mindriot101/rust-fitsio/pull/100)
* (`fitsio`) fix errors with the system allocator, ensuring the package will run on the latest nightly and beta compilers [#100](https://github.com/simonrw/rust-fitsio/pull/100)

### Removed

## [0.14.0] - 2018-04-21

### Added

* (`fitsio`) add `overwrite` method to `NewFitsFile` [#94](https://github.com/mindriot101/rust-fitsio/pull/94)
* (`fitsio`) add `ndarray` support [#92](https://github.com/mindriot101/rust-fitsio/pull/92)
* (`fitsio`) add `overwrite` method to `NewFitsFile` [#94](https://github.com/simonrw/rust-fitsio/pull/94)
* (`fitsio`) add `ndarray` support [#92](https://github.com/simonrw/rust-fitsio/pull/92)
* (`fitsio`) add lots of documentation

### Changed

* (`fitsio`) **BREAKING CHANGE**: move code into more logical submodule arrangement [#95](https://github.com/mindriot101/rust-fitsio/pull/95)
* (`fitsio`) add long cfitsio function names internally [#88](https://github.com/mindriot101/rust-fitsio/pull/88)
* (`fitsio`) **BREAKING CHANGE**: move code into more logical submodule arrangement [#95](https://github.com/simonrw/rust-fitsio/pull/95)
* (`fitsio`) add long cfitsio function names internally [#88](https://github.com/simonrw/rust-fitsio/pull/88)

### Removed

## [0.13.0] - 2018-03-10

### Addded

* (`fitsio`) add `row` method to read single row. This allows the user to declare a custom struct representing the row values [#86](https://github.com/mindriot101/rust-fitsio/pull/86)
* (`fitsio`) add pretty-printing support [#83](https://github.com/mindriot101/rust-fitsio/pull/83)
* (`fitsio`) add `primary_hdu` method [#77](https://github.com/mindriot101/rust-fitsio/pull/77)
* (`fitsio`) add `row` method to read single row. This allows the user to declare a custom struct representing the row values [#86](https://github.com/simonrw/rust-fitsio/pull/86)
* (`fitsio`) add pretty-printing support [#83](https://github.com/simonrw/rust-fitsio/pull/83)
* (`fitsio`) add `primary_hdu` method [#77](https://github.com/simonrw/rust-fitsio/pull/77)

### Changed

* (`fitsio`) **BREAKING CHANGE**: changed ImageType variants to be more rusty [#84](https://github.com/mindriot101/rust-fitsio/pull/84)
* (`fitsio`) `create_image` and `create_table` take `Into<String>` [#81](https://github.com/mindriot101/rust-fitsio/pull/81)
* (`fitsio`) `WritesKey::write_key` now accepts &str's as well as `String`s [#80](https://github.com/mindriot101/rust-fitsio/pull/80)
* (`fitsio`) **BREAKING CHANGE**: all ranges are now exclusive of the upper value, matching Rust's default behaviour [#61](https://github.com/mindriot101/rust-fitsio/pull/61)
* (`fitsio`) **BREAKING CHANGE**: inverted the order of image/region axes to match the C row-major convention [#59](https://github.com/mindriot101/rust-fitsio/pull/59)
* (`fitsio`) **BREAKING CHANGE**: changed ImageType variants to be more rusty [#84](https://github.com/simonrw/rust-fitsio/pull/84)
* (`fitsio`) `create_image` and `create_table` take `Into<String>` [#81](https://github.com/simonrw/rust-fitsio/pull/81)
* (`fitsio`) `WritesKey::write_key` now accepts &str's as well as `String`s [#80](https://github.com/simonrw/rust-fitsio/pull/80)
* (`fitsio`) **BREAKING CHANGE**: all ranges are now exclusive of the upper value, matching Rust's default behaviour [#61](https://github.com/simonrw/rust-fitsio/pull/61)
* (`fitsio`) **BREAKING CHANGE**: inverted the order of image/region axes to match the C row-major convention [#59](https://github.com/simonrw/rust-fitsio/pull/59)

### Removed

Expand Down Expand Up @@ -222,29 +231,30 @@ Nothing

Nothing

[Unreleased]: https://github.com/mindriot101/rust-fitsio/compare/v0.14.0...HEAD
[0.9.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.8.0...v0.9.0
[pull-34]: https://github.com/mindriot101/rust-fitsio/pull/34
[pull-32]: https://github.com/mindriot101/rust-fitsio/pull/32
[pull-31]: https://github.com/mindriot101/rust-fitsio/pull/31
[pull-43]: https://github.com/mindriot101/rust-fitsio/pull/43
[pull-44]: https://github.com/mindriot101/rust-fitsio/pull/44
[pull-45]: https://github.com/mindriot101/rust-fitsio/pull/45
[pull-46]: https://github.com/mindriot101/rust-fitsio/pull/46
[0.10.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.9.0...v0.10.0
[0.11.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.10.0...v0.11.0
[0.11.1]: https://github.com/mindriot101/rust-fitsio/compare/v0.10.0...v0.11.1
[0.12.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.11.1...v0.12.0
[0.12.1]: https://github.com/mindriot101/rust-fitsio/compare/v0.12.0...v0.12.1
[0.13.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.12.1...v0.13.0
[0.14.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.13.0...v0.14.0
[0.14.1]: https://github.com/mindriot101/rust-fitsio/compare/v0.14.0...v0.14.1
[0.15.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.14.1...v0.15.0
[0.16.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.15.0...v0.16.0
[0.17.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.16.0...v0.17.0
[0.18.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.17.0...v0.18.0
[0.19.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.18.0...v0.19.0
[0.20.0]: https://github.com/mindriot101/rust-fitsio/compare/v0.19.0...v0.20.0
[Unreleased]: https://github.com/simonrw/rust-fitsio/compare/v0.21.0...HEAD
[0.9.0]: https://github.com/simonrw/rust-fitsio/compare/v0.8.0...v0.9.0
[pull-34]: https://github.com/simonrw/rust-fitsio/pull/34
[pull-32]: https://github.com/simonrw/rust-fitsio/pull/32
[pull-31]: https://github.com/simonrw/rust-fitsio/pull/31
[pull-43]: https://github.com/simonrw/rust-fitsio/pull/43
[pull-44]: https://github.com/simonrw/rust-fitsio/pull/44
[pull-45]: https://github.com/simonrw/rust-fitsio/pull/45
[pull-46]: https://github.com/simonrw/rust-fitsio/pull/46
[0.10.0]: https://github.com/simonrw/rust-fitsio/compare/v0.9.0...v0.10.0
[0.11.0]: https://github.com/simonrw/rust-fitsio/compare/v0.10.0...v0.11.0
[0.11.1]: https://github.com/simonrw/rust-fitsio/compare/v0.10.0...v0.11.1
[0.12.0]: https://github.com/simonrw/rust-fitsio/compare/v0.11.1...v0.12.0
[0.12.1]: https://github.com/simonrw/rust-fitsio/compare/v0.12.0...v0.12.1
[0.13.0]: https://github.com/simonrw/rust-fitsio/compare/v0.12.1...v0.13.0
[0.14.0]: https://github.com/simonrw/rust-fitsio/compare/v0.13.0...v0.14.0
[0.14.1]: https://github.com/simonrw/rust-fitsio/compare/v0.14.0...v0.14.1
[0.15.0]: https://github.com/simonrw/rust-fitsio/compare/v0.14.1...v0.15.0
[0.16.0]: https://github.com/simonrw/rust-fitsio/compare/v0.15.0...v0.16.0
[0.17.0]: https://github.com/simonrw/rust-fitsio/compare/v0.16.0...v0.17.0
[0.18.0]: https://github.com/simonrw/rust-fitsio/compare/v0.17.0...v0.18.0
[0.19.0]: https://github.com/simonrw/rust-fitsio/compare/v0.18.0...v0.19.0
[0.20.0]: https://github.com/simonrw/rust-fitsio/compare/v0.19.0...v0.20.0
[0.21.0]: https://github.com/simonrw/rust-fitsio/compare/v0.20.0...v0.21.0

---

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Or pin a specific version:

```toml
[dependencies]
fitsio = "0.20.0"
fitsio = "0.21.0"
```

This repository contains `fitsio-sys-bindgen` which generates the C
Expand All @@ -91,7 +91,7 @@ or use from your `Cargo.toml` as such:

```toml
[dependencies]
fitsio = { version = "0.20.0", default-features = false, features = ["bindgen"] }
fitsio = { version = "0.21.0", default-features = false, features = ["bindgen"] }
```

## Documentation
Expand Down
2 changes: 1 addition & 1 deletion fitsio-sys/Cargo.toml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fitsio-sys"
version = "0.4.2"
version = "0.5.0"
edition = "2018"
authors = ["Simon Walker <s.r.walker101@googlemail.com>"]
description = "FFI wrapper around cfitsio"
Expand Down
10 changes: 5 additions & 5 deletions fitsio/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ license = "MIT/Apache-2.0"
name = "fitsio"
readme = "README.md"
repository = "https://github.com/mindriot101/rust-fitsio"
version = "0.20.0"
version = "0.21.0"
rust-version = "1.57.0"

[package.metadata.docs.rs]
features = ["array"]
targets = ["x86_64-unknown-linux-gnu"]

[dependencies]
fitsio-sys = {version = "0.4.2", path = "../fitsio-sys", optional = true}
fitsio-sys-bindgen = {version = "0.0.5", path = "../fitsio-sys-bindgen", optional = true}
fitsio-sys = { version = "0.5.0", path = "../fitsio-sys", optional = true }
fitsio-sys-bindgen = { version = "0.0.5", path = "../fitsio-sys-bindgen", optional = true }
libc = "0.2.44"
ndarray = {version = "0.15.0", optional = true}
ndarray = { version = "0.15.0", optional = true }

[dev-dependencies]
criterion = "0.3.5"
fitsio-derive = {version = "0.2.0", path = "../fitsio-derive"}
fitsio-derive = { version = "0.2.0", path = "../fitsio-derive" }
tempfile = "3.0.0"
version-sync = "0.9.0"

Expand Down
2 changes: 1 addition & 1 deletion fitsio/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1029,7 +1029,7 @@ let _hdu = t.hdu(hdu_num).unwrap();
[threadsafe-fits-file]: threadsafe_fitsfile/struct.ThreadsafeFitsFile.html
*/

#![doc(html_root_url = "https://docs.rs/fitsio/0.20.0")]
#![doc(html_root_url = "https://docs.rs/fitsio/0.21.0")]
#![deny(missing_docs)]
#![cfg_attr(feature = "clippy", feature(plugin))]
#![cfg_attr(feature = "clippy", plugin(clippy))]
Expand Down

0 comments on commit 37e251b

Please sign in to comment.