Skip to content

Commit

Permalink
release: Prep v0.4.0 for release + update CHANGELOG.md (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
ConnorGray authored Dec 15, 2022
1 parent 07f5964 commit 9df6a40
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "wolfram-app-discovery"
version = "0.3.0"
version = "0.4.0"
license = "MIT OR Apache-2.0"
readme = "README.md"
repository = "https://github.com/WolframResearch/wolfram-app-discovery-rs"
Expand Down
57 changes: 56 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0



## [0.4.0] — 2022-12-14

### Added

* Added support for app discovery on Linux ([#28])

This address issue [#27].

[`discover()`](https://docs.rs/wolfram-app-discovery/0.4.0/wolfram_app_discovery/fn.discover.html)
will now return all Wolfram apps found in the default installation location
on Linux (currently just `/usr/local/Wolfram/`).

[`WolframApp::from_app_directory()`](https://docs.rs/wolfram-app-discovery/0.4.0/wolfram_app_discovery/struct.WolframApp.html#method.from_app_directory)
can now be used to get information on a Wolfram app installed in a non-standard
location.

The following `WolframApp` methods are now supported on Linux:

- [`WolframApp::installation_directory()`](https://docs.rs/wolfram-app-discovery/0.4.0/wolfram_app_discovery/struct.WolframApp.html#method.installation_directory)
- [`WolframApp::kernel_executable_path()`](https://docs.rs/wolfram-app-discovery/0.4.0/wolfram_app_discovery/struct.WolframApp.html#method.kernel_executable_path)
- [`WolframApp::wolframscript_executable_path()`](https://docs.rs/wolfram-app-discovery/0.4.0/wolfram_app_discovery/struct.WolframApp.html#method.wolframscript_executable_path)
- [`WolframApp::wstp_static_library_path()`](https://docs.rs/wolfram-app-discovery/0.4.0/wolfram_app_discovery/struct.WolframApp.html#method.wstp_static_library_path)

* Added custom logic for determining app metadata, in the absence of an
available standard OS-provided format or API. At the moment, this consists
of parsing LICENSE.txt and the WolframKernel script for the application type
and version number, respectively.

This is likely more fragile than the implementation methods used on macOS and
Windows, but necessary and sufficient for the time being to get discovery
working for the most common use-cases. Future improvements are expected.

### Changed

#### Backwards Incompatible

- Changed the [`AppVersion::build_code()`] method to return `Option<u32>`
(was `u32`). ([#28])

### Fixed

- Fixed an issue with platform unsupported error generated by
`WolframApp::installation_directory()` incorrectly reporting that the error
was in `WolframApp::from_app_directory()`. ([#28])

- Filled in an erroneously incomplete `todo!()` in the `Display` impl for
`Error`. ([#28])




## [0.3.0] – 2022-09-19

### Added
Expand Down Expand Up @@ -172,10 +223,14 @@ Initial release of `wolfram-app-discovery`.
[#24]: https://github.com/WolframResearch/wolfram-app-discovery-rs/pull/24
[#25]: https://github.com/WolframResearch/wolfram-app-discovery-rs/pull/25

<!-- v0.4.0 -->
[#27]: https://github.com/WolframResearch/wolfram-app-discovery-rs/issues/27
[#28]: https://github.com/WolframResearch/wolfram-app-discovery-rs/pull/28

<!-- This needs to be updated for each tagged release. -->
[Unreleased]: https://github.com/WolframResearch/wolfram-app-discovery-rs/compare/v0.3.0...HEAD
[Unreleased]: https://github.com/WolframResearch/wolfram-app-discovery-rs/compare/v0.4.0...HEAD

[0.4.0]: https://github.com/WolframResearch/wolfram-app-discovery-rs/compare/v0.3.0...v0.4.0
[0.3.0]: https://github.com/WolframResearch/wolfram-app-discovery-rs/compare/v0.2.2...v0.3.0
[0.2.2]: https://github.com/WolframResearch/wolfram-app-discovery-rs/compare/v0.2.1...v0.2.2
[0.2.1]: https://github.com/WolframResearch/wolfram-app-discovery-rs/compare/v0.2.0...v0.2.1
Expand Down

0 comments on commit 9df6a40

Please sign in to comment.