From 54d16e59cd938615ff8d09ec629433db77824892 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niko=20F=C3=B6hr?= Date: Sun, 26 May 2024 11:27:45 +0300 Subject: [PATCH 1/2] add todos --- DEV.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/DEV.md b/DEV.md index 757518ac..b24c0846 100644 --- a/DEV.md +++ b/DEV.md @@ -4,9 +4,12 @@ This document serves as documentation for the package developers. ## Branches and tags +TODO: fix - **`dev`** branch: for development. All PRs should be against it. Documented at [wakepy.readthedocs.io/dev/](https://wakepy.readthedocs.io/dev/) - **`main`** branch: The stable/released version(s) of wakepy. Documented at [wakepy.readthedocs.io](https://wakepy.readthedocs.io/), which is the same as the [wakepy.readthedocs.io/stable/](https://wakepy.readthedocs.io/stable/). - Use a local short-lived feature branch for development. + +TODO: fix - Release versions use [Semantic Versioning](https://semver.org/) and are marked with git tags (on the dev branch) with format `v[major].[minor].[patch]`; e.g. v1.2.0 or v2.2.0. ## Installing for development @@ -34,6 +37,8 @@ invoke docs - **Deploying**: Just push to github, and it will be automatically built by readthedocs. The settings can be adjusted [here](https://readthedocs.org/dashboard). - Versions selected for documentation are selected in the readthedocs UI. Select one version per `major.minor` version (latest of them) from the git tags. + +TODO: fix this: - The `latest` version (default versio) in readthedocs follows the `main` branch automatically. From 2d237d92cb704c4175a661bf571c0df28d9d7ddb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niko=20F=C3=B6hr?= Date: Sun, 26 May 2024 11:59:06 +0300 Subject: [PATCH 2/2] update DEV.md --- DEV.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/DEV.md b/DEV.md index b24c0846..5f463ffd 100644 --- a/DEV.md +++ b/DEV.md @@ -4,13 +4,9 @@ This document serves as documentation for the package developers. ## Branches and tags -TODO: fix -- **`dev`** branch: for development. All PRs should be against it. Documented at [wakepy.readthedocs.io/dev/](https://wakepy.readthedocs.io/dev/) -- **`main`** branch: The stable/released version(s) of wakepy. Documented at [wakepy.readthedocs.io](https://wakepy.readthedocs.io/), which is the same as the [wakepy.readthedocs.io/stable/](https://wakepy.readthedocs.io/stable/). +- **`main`** branch: The only long-living branch. All PRs are done against it. - Use a local short-lived feature branch for development. - -TODO: fix -- Release versions use [Semantic Versioning](https://semver.org/) and are marked with git tags (on the dev branch) with format `v[major].[minor].[patch]`; e.g. v1.2.0 or v2.2.0. +- Releases use [Semantic Versioning](https://semver.org/) and are marked with git tags (on the `main` branch) with format `v[major].[minor].[patch]`; e.g. v1.2.0 or v2.2.0. ## Installing for development @@ -38,10 +34,10 @@ invoke docs - **Deploying**: Just push to github, and it will be automatically built by readthedocs. The settings can be adjusted [here](https://readthedocs.org/dashboard). - Versions selected for documentation are selected in the readthedocs UI. Select one version per `major.minor` version (latest of them) from the git tags. -TODO: fix this: -- The `latest` version (default versio) in readthedocs follows the `main` branch automatically. - - +### urls +- The `stable` version in readthedocs ([wakepy.readthedocs.io/stable/](https://wakepy.readthedocs.io/stable/)) is the latest *release* (tagged version), as documented in [here](https://docs.readthedocs.io/en/stable/versions.html). +- The `latest` version in readthedocs ([wakepy.readthedocs.io/latest/](https://wakepy.readthedocs.io/latest/)) follows the HEAD of the `main` branch automatically. This is the *development* version. +- The released versions X.Y.Z can also be accessed at `wakepy.readthedocs.io/vX.Y.Z/` # Testing