diff --git a/DEPLOY.md b/DEPLOY.md index ad049537544338f9f0afbd161ae6b61663dbacdd..cfb0556f0339e4754de7ed8f4b9b6dff1853982d 100644 --- a/DEPLOY.md +++ b/DEPLOY.md @@ -1,9 +1,5 @@ # Deployment of new UFrameIT Releases -TODO: describe how to deploy here - -## Versioning - We use semantic versioning. A version number looks like `x.y.z`, no `v` prefix. Always release all of @@ -14,10 +10,20 @@ Always release all of at the same time with the *same* version number. -Concretely: +**How to make a new release** + +1. Deploy prereleases on the [UFrameIT/UFrameIT GitHub repo](https://github.com/UFrameIT/UFrameIT/releases) for all OS. See below how to do that. +2. Let people test. +3. Merge [FrameIT/frameworld](https://gl.mathhub.info/FrameIT/frameworld)'s devel branch into master and git-tag with `x.y.z`. +4. Update archive submodules in [UFrameIT/archives](https://github.com/UFrameIT/archives) and git-tag with `x.y.z`. +5. Git-tag [UFrameIT/UFrameIT](https://github.com/UFrameIT/UFrameIT) (this repo) with `x.y.z.`. +6. Publish prerelease from step 1. +7. Write a news post on our website: <https://github.com/UFrameIT/UFrameIT.github.io> + + +**Deploying binaries for UFrameIT** + +- Archive type -1. Merge [FrameIT/frameworld](https://gl.mathhub.info/FrameIT/frameworld)'s devel branch into master and git-tag with `x.y.z`. -2. Update archive submodules in [UFrameIT/archives](https://github.com/UFrameIT/archives) and git-tag with `x.y.z`. -3. Git-tag [UFrameIT/UFrameIT](https://github.com/UFrameIT/UFrameIT) (this repo) with `x.y.z.`. -4. Create a new GitHub release here: <https://github.com/UFrameIT/UFrameIT/releases> -5. Write a news post on our website: <https://github.com/UFrameIT/UFrameIT.github.io> + - For Linux and macOS, deploy `.tar.gz` files (-> smallest file size as compared to `.zip` and `.tar`). + - For Windows, deploy `.zip` files (-> guaranteed compatibility among end users since Windows Explorer can open them)