Skip to content

Commit

Permalink
Release version 0.2.0 (#79)
Browse files Browse the repository at this point in the history
## Describe your changes

Going by the [roadmap](https://github.com/mllam/neural-lam/wiki/Roadmap)
we are ready to release version 0.2.0 🥳

This PR just updates the changelog for this release (and also re-orders
one entry that was put in the wrong place). Now this does the changelog
update first, and then we create the release for the commit with the
update, but I guess the order of this does not matter much.

Something I am unsure about is if we want to now remove this version
with the completed items from the roadmap? Could be good to have
archived somewhere. Perhaps we could add a section for finished releases
at the bottom.

## Github TODOs after meged:

- [ ] Create release (there is a draft release ready)
- [ ] Update roadmap

## Type of change

- [ ] 🐛 Bug fix (non-breaking change that fixes an issue)
- [ ] ✨ New feature (non-breaking change that adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] 📖 Documentation (Addition or improvements to documentation)

## Checklist before requesting a review

- [x] My branch is up-to-date with the target branch - if not update
your fork with the changes from the target branch (use `pull` with
`--rebase` option if possible).
- [ ] I have performed a self-review of my code
- [ ] For any new/modified functions/classes I have added docstrings
that clearly describe its purpose, expected inputs and returned values
- [ ] I have placed in-line comments to clarify the intent of any
hard-to-understand passages of my code
- [ ] I have updated the [README](README.MD) to cover introduced code
changes
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [x] I have given the PR a name that clearly describes the change,
written in imperative form
([context](https://www.gitkraken.com/learn/git/best-practices/git-commit-message#using-imperative-verb-form)).
- [x] I have requested a reviewer and an assignee (assignee is
responsible for merging). This applies only if you have write access to
the repo, otherwise feel free to tag a maintainer to add a reviewer and
assignee.

## Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should
check the following:
- [ ] the code is readable
- [ ] the code is well tested
- [ ] the code is documented (including return types and parameters)
- [ ] the code is easy to maintain

## Author checklist after completed review

- [ ] I have added a line to the CHANGELOG describing this change, in a
section
  reflecting type of change (add section where missing):
  - *added*: when you have added new functionality
  - *changed*: when default behaviour of the code has been changed
  - *fixes*: when your contribution fixes a bug

## Checklist for assignee

- [x] PR is up to date with the base branch
- [x] the tests pass
- [ ] author has added an entry to the changelog (and designated the
change as *added*, *changed* or *fixed*)
- Once the PR is ready to be merged, squash commits and merge the PR.
  • Loading branch information
joeloskarsson authored Oct 24, 2024
1 parent a7d6bf7 commit 2d36857
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [unreleased](https://github.com/joeloskarsson/neural-lam/compare/v0.1.0...HEAD)
## [unreleased](https://github.com/joeloskarsson/neural-lam/compare/v0.2.0...HEAD)

## [v0.2.0](https://github.com/joeloskarsson/neural-lam/releases/tag/v0.2.0)

### Added
- Added tests for loading dataset, creating graph, and training model based on reduced MEPS dataset stored on AWS S3, along with automatic running of tests on push/PR to GitHub, including push to main branch. Added caching of test data to speed up running tests.
Expand Down Expand Up @@ -81,10 +83,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Maintenance

- Add slack and new publication info to readme
[\#78](https://github.com/mllam/neural-lam/pull/78)
@joeloskarsson

- simplify pre-commit setup by 1) reducing linting to only cover static
analysis excluding imports from external dependencies (this will be handled
in build/test cicd action introduced later), 2) pinning versions of linting
Expand Down Expand Up @@ -120,6 +118,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- move from `requirements.txt` to `pyproject.toml` for defining package dependencies.
[\#37](https://github.com/mllam/neural-lam/pull/37), @leifdenby

- Add slack and new publication info to readme
[\#78](https://github.com/mllam/neural-lam/pull/78)
@joeloskarsson

## [v0.1.0](https://github.com/joeloskarsson/neural-lam/releases/tag/v0.1.0)

First tagged release of `neural-lam`, matching Oskarsson et al 2023 publication
Expand Down

0 comments on commit 2d36857

Please sign in to comment.