.github/ISSUE_TEMPLATE/checklist-for-release.md

   1 ---
   2 name: Checklist for release
   3 about: A template when making a release (usage reserved to repo maintainers)
   4 title: "[RELEASE 4.x] Checklist"
   5 labels: Release
   6 assignees: doegox, iceman1001
   7
   8 ---
   9
  10 # Checklist
  11
  12 - [ ] `make style`
  13 - [ ] `make miscchecks`
  14 - [ ] `make clean; make client CC=clang CXX=clang++ LD=clang++` on recent Debian or Ubuntu
  15 - [ ] `mymanualchecks.sh`
  16 - [ ] `mycppcheck.sh` no alarming warning?
  17 - [ ] `tools/build_all_firmwares.sh` check that the script contains all standalone modes then compile all standalone modes (linux only)
  18 - [ ] `experimental_lib` compilation & tests
  19 - [ ] `experimental_client_with_swig` compilation & tests
  20 - [ ] GitHub Actions - green across the board ( MacOS, Ubuntu, Windows)
  21
  22 # OS compilation and tests
  23
  24 Run `tools/release_tests.sh` on:
  25
  26 - [ ] RPI Zero
  27 - [ ] Jetson Nano
  28 - [ ] WSL
  29 - [ ] PSv3.xx
  30 - [ ] Archlinux
  31 - [ ] Kali
  32 - [ ] Debian Stable
  33 - [ ] Debian Testing
  34 - [ ] Ubuntu 22
  35 - [ ] ParrotOS
  36 - [ ] Fedora 37
  37 - [ ] OpenSuse Leap
  38 - [ ] OpenSuse Tumbleweed
  39 - [ ] OSX (MacPorts)
  40 - [ ] OSX (Homebrew)
  41 - [ ] Android
  42 - [ ] Termux
  43
  44 # creating release
  45
  46 - [ ] CHANGELOG.md: add title: `## [myreleasename][YYYY-MM-DD]`
  47 - [ ] `make release RELEASE_NAME="myreleasename"`
  48   - last line of output gives you next command to run.
  49   - Sample:  `git push && git push origin v4.12345`
  50 - [ ] CHANGELOG.md: edit title to add version info: `## [myreleasename.4.12345][YYYY-MM-DD]`
  51
  52 ## Step Github releases
  53
  54 - [ ] Go to Github releases,  create release based on the new created tag and publish
  55   - Choose a tag: v4.12345
  56   - Target: master
  57   - Set as the latest release
  58   - Title: `proxmark3-v4.12345`
  59   - Description:
  60 ```
  61 Release v4.12345
  62 Nickname "myreleasename"
  63 ```
  64
  65 ## Step Homebrew updates
  66
  67 - [ ] update homebrew repo, file `proxmark3.rb`
  68   - with a SHA256 sum of the file `v4.12345.tar.gz`
  69   - with updated list of standalone modes
  70
  71 ## Step package maintains
  72
  73 - [ ] make a list of new standalone modes, so when we alert package maintainers they have a sporting chance of adding them