Skip to content
Snippets Groups Projects

doc: update release howto

Merged doc: update release howto
signing-doc into main
4 unresolved threads
Merged jkito requested to merge signing-doc into main
4 unresolved threads

this changes the doc from rst to a markdown file and adds steps for signing the windows and macOS installers

fixes #896 (closed)

Edited by jkito

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
docs/release-howto.md 0 → 100644
17
18 ## Build Installers for Windows and MacOS
19
20 ### Steps to build the windows installer (needs Windows 10 or higher):
21
22 1. Generate the installer `.exe` file
23
24 ```
25 $ make vendor # make sure to set the PROVIDER env variable to the correct provider
26 $ make build
27 $ make installer
28 ```
29 2. Sign the installer:
30
31 ```
32 PS> signtool sign /f .\leap.pfx /tr http://timestamp.digicert.com /td SHA256 /fd SHA256 /p <password_for_cert> <path_to_installer.exe>
  • Pea Nut
    Pea Nut @peanut2
    Developer
    • Is signtool a windows tool and automatically preinstalled?
    • What's the purpose of http://timestamp.digicert.com and why is it unencrypted (and it seems broken, ssl not working, port 80 returns 404)?
  • jkito
    jkito @jkito
    Author Maintainer

    yes its a windows only tool, that needs to be installed

  • Please register or sign in to reply
  • Pea Nut
    Pea Nut @peanut2 started a thread on the diff
    • docs/release-howto.md 0 → 100644
    1 # Release procedure
    2
    3 ## Prepare source code repo for release
    4
    5 1. Generate the changelog and update the `CHANGELOG` file
    6
    7 ```
    8 $ git log --format="- %s" <last_release_tag>..HEAD
    9 ```
    10 2. Open a Merge request with the above change
    11 3. Create an annotated tag for the release version, the version for the app is taken from the o/p of `git desribe`
    12
    13 ```
    14 # tag should point to the commit that updated the CHANGELOG file
    15 $ git tag -a 0.24.8 HEAD
    • Pea Nut
      Pea Nut @peanut2
      Developer

      What's the purpose of git tag -a?

             -a, --annotate
           Make an unsigned, annotated tag object
    • jkito
      jkito @jkito
      Author Maintainer

      it adds an annotation (some text) but the technical reason we want annotated tags is because the git describe we use in the Makefile (without any other flags) only lists tags that are annotated

    • Please register or sign in to reply
  • Pea Nut
    Pea Nut @peanut2 started a thread on the diff
    • docs/release-howto.md 0 → 100644
    1 # Release procedure
  • Pea Nut added 15m of time spent at 2024-11-08

    added 15m of time spent at 2024-11-08

  • Pea Nut added 2 commits

    added 2 commits

    Compare with previous version

  • Pea Nut approved this merge request

    approved this merge request

  • jkito added 20 commits

    added 20 commits

    Compare with previous version

  • jkito mentioned in issue #896 (closed)

    mentioned in issue #896 (closed)

  • jkito added 6 commits

    added 6 commits

    Compare with previous version

  • jkito merged

    merged

    • Please register or sign in to reply