Skip to content

Commit

Permalink
Prep for v1.0.0 (#564)
Browse files Browse the repository at this point in the history
  • Loading branch information
odow authored Jan 3, 2023
1 parent 994c0a7 commit c1e4659
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "SDDP"
uuid = "f4570300-c277-11e8-125c-4912f86ce65d"
authors = ["Oscar Dowson <[email protected]"]
version = "0.4.9"
version = "1.0.0"

[deps]
Distributed = "8ba89e20-285c-5b6f-9357-94700520ee1b"
Expand Down
30 changes: 30 additions & 0 deletions docs/src/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,36 @@ CurrentModule = SDDP
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## v1.0.0 (January 3, 2023)

Although we're bumping MAJOR version, this is a non-breaking release. Going
forward:

* New features will bump the MINOR version
* Bug fixes, maintenance, and documentation updates will bump the PATCH
version
* We will support only the Long Term Support (currently v1.6.7) and the latest
patch (currently v1.8.4) releases of Julia. Updates to the LTS version will
bump the MINOR version
* Updates to the compat bounds of package dependencies will bump the PATCH
version.

We do not intend any breaking changes to the public API, which would require a
new MAJOR release. The public API is everything defined in the documentation.
Anything not in the documentation is considered private and may change in any
PATCH release.

### Added

* Added `num_nodes` argument to [`SDDP.UnicyclicGraph`](@ref) (#562)
* Added support for passing an optimizer to [`SDDP.Asynchronous`](@ref) (#545)

### Other

* Updated [Plotting tools](@ref) to use live plots (#563)
* Added [vale](https://vale.sh) as a linter (#565)
* Improved documentation for initializing a parallel scheme (#566)

## v0.4.9 (January 3, 2023)

### Added
Expand Down

2 comments on commit c1e4659

@odow
Copy link
Owner Author

@odow odow commented on c1e4659 Jan 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/74957

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" c1e465960cf07a624a040d53c811154b165ade1d
git push origin v1.0.0

Please sign in to comment.