diff --git a/CHANGELOG.md b/CHANGELOG.md index 3dc35df..17516dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ 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). -## [Unreleased] +## [0.2.0] Minor Release - Oh Hi Mike - 2023-08-11 ### Added - Add documentation version control with mike [(#47)](https://github.com/rl-institut/super-repo/pull/47) @@ -15,9 +15,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Update issue templates and release procedure [(#47)](https://github.com/rl-institut/super-repo/pull/47) -### Removed -- [(#)]() - ## [0.1.1] Patch Release - Emmy Hennings Day Patch - 2023-08-10 diff --git a/CITATION.cff b/CITATION.cff index 0c073ca..8fda0b8 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -9,7 +9,7 @@ authors: title: "Super Repo" type: software license: MIT -version: 0.1.1 +version: 0.2.0 doi: -date-released: 2023-08-10 +date-released: 2023-08-11 url: "https://github.com/rl-institut/super-repo/" \ No newline at end of file diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index b172db7..8475e47 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -85,8 +85,8 @@ For a **Patch Release** (Hotfix), start at [section 3](https://github.com/rl-ins ▢️ Increase version numbers! ### 7. πŸ™ Create a Release Pull Request -* Use `πŸ“PR_TEMPLATE_RELEASE` (❗ToDo❗) * Merge `release` into `production` branch +* Remove details from template * Assign two reviewers to check the release * Run all test * Execute the software locally diff --git a/docs/development/documentation/index.md b/docs/development/documentation/index.md index 1ba73c0..5134d83 100644 --- a/docs/development/documentation/index.md +++ b/docs/development/documentation/index.md @@ -37,9 +37,10 @@ It is configured to be pushed to the branch `gh-page` and then deployed online. A commit on the `production` branch triggers the workflow. ### Mike -The package [mike](https://github.com/jimporter/mike) is used to deploy [multiple versions](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=versioning) of the documentation. +The package [mike](https://github.com/jimporter/mike) is used to deploy [multiple versions](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=versioning) of the documentation.
πŸ’» `pip install mike` install mike
πŸ’» `mike deploy --push --update-aliases 0.1.0 latest` deploys the latest version
+πŸ’» `mike set-default --push latest` Set the default version to latest ## mkdocstrings [mkdocstrings](https://mkdocstrings.github.io/) generates automatic