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

Issue 305 remove dev branch #306

Merged
merged 2 commits into from
May 26, 2024
Merged

Issue 305 remove dev branch #306

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54d16e5
add todos
fohrloop May 26, 2024
2d237d9
update DEV.md
fohrloop May 26, 2024
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
11 changes: 6 additions & 5 deletions DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@ This document serves as documentation for the package developers.

## Branches and tags

- **`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.
- 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

Expand All @@ -34,9 +33,11 @@ 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.
- 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

Expand Down