Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Set up new development after release v0.2.0 #53

Merged
merged 5 commits into from
Aug 11, 2023
Merged

Set up new development after release v0.2.0 #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e859e7
Update changelog #50
Ludee Aug 11, 2023
e149300
Update citation #50
Ludee Aug 11, 2023
7a824f1
Update release procedure #50
Ludee Aug 11, 2023
0999ad7
Merge pull request #51 from rl-institut/release-v0.2.0
Ludee Aug 11, 2023
6a95885
Update documentation manually to test mike #36
Ludee Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,14 @@ 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)

### 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

Expand Down
4 changes: 2 additions & 2 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
2 changes: 1 addition & 1 deletion RELEASE_PROCEDURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/development/documentation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br>
💻 `pip install mike` install mike <br>
💻 `mike deploy --push --update-aliases 0.1.0 latest` deploys the latest version <br>
💻 `mike set-default --push latest` Set the default version to latest

## mkdocstrings
[mkdocstrings](https://mkdocstrings.github.io/) generates automatic
Expand Down
Loading