Skip to content

Commit 58a9b88

Browse files
committed
Add release build instructions to README
1 parent 44f1851 commit 58a9b88

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,46 @@ We've used [cargo-wix](https://github.com/volks73/cargo-wix) to create the Windo
340340
Further instructions for it's usage can be found on the given repository.
341341
Please mind that the *License.rtf* has been modified (for the copyright part) and changed the manufacturer has been to University of Helsinki in the *main.wxs* file. We have not implemented creating the installer in the GitHub Actions, so it needs to be done manually.
342342

343+
Github actions builds every commit and runs all tests on them on every supported platform. When tests
344+
are successful there is a option to create a release build. These are triggered by creating a
345+
tag on the commit you want to create release from. Usually commits are tagged with version like this:
346+
```
347+
git tag v0.0.1
348+
```
349+
Only hard requirement is that all tags which are used to create release builds **must begin with letter v**.
350+
Release builds are uploaded to [download.mooc.fi](https://download.mooc.fi/). Each release can be downloaded
351+
by using url:
352+
```
353+
https://download.mooc.fi/tmc-cli-rust/tmc-cli-rust-<ARCH>-<PLATFORM>-<VERSION>.<EXT>
354+
```
355+
356+
where each <> should be replaced with one of these:
357+
358+
- ARCH: x86_64, i686
359+
- PLATFORM: pc-windows-msvc, unknown-linux-gnu, apple-darwin
360+
- VERSION: This one is given by the tag (e.g v0.0.1)
361+
- EXT: On windows: exe. On other platforms this is empty.
362+
363+
When in doubt, you can always check all downloadable files at [download.mooc.fi](https://download.mooc.fi/)
364+
by examining the xml file manually.
365+
366+
For example x86_64 downloads for v.0.3.5 look like this:
367+
```
368+
https://download.mooc.fi/tmc-cli-rust/tmc-cli-rust-x86_64-unknown-linux-gnu-v0.3.5
369+
https://download.mooc.fi/tmc-cli-rust/tmc-cli-rust-x86_64-apple-darwin-v0.3.5
370+
https://download.mooc.fi/tmc-cli-rust/tmc-cli-rust-x86_64-pc-windows-msvc-v0.3.5.exe
371+
```
372+
373+
When it comes to creating releases, our typical workflow looks like this:
374+
375+
First make sure that all tests pass then:
376+
```
377+
git checkout main
378+
git merge dev
379+
git tag v0.0.1
380+
git push --tags
381+
```
382+
343383
### Formatting
344384

345385
Code should be formatted with [rustfmt](https://github.com/rust-lang/rustfmt)

0 commit comments

Comments
 (0)