.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 - [ ] CHANGELOG.md
  13 - [ ] `make style`
  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 - [ ] `mystandalone_makes.sh` check that the script contains all standalone modes then compile all standalone modes (linux only)
  18 - [ ] GitHub Actions - green across the board ( MacOS, Ubuntu, Windows)
  19 - [ ] [Appveyor](https://ci.appveyor.com/project/RfidResearchGroup/proxmark3/history) green (PS)
  20
  21 # OS compilation and tests
  22
  23 ```bash
  24 #!/usr/bin/env bash
  25
  26 make clean && make -j PLATFORM=PM3GENERIC && tools/pm3_tests.sh --long
  27 make clean && make -j PLATFORM=PM3RDV4 && tools/pm3_tests.sh --long
  28 make clean && make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS=BTADDON && tools/pm3_tests.sh --long
  29 sudo make install; pushd /tmp; proxmark3 -c 'data load -f lf_EM4x05.pm3;lf search -1'; popd; sudo make uninstall
  30
  31 ( cd client; rm -rf build; mkdir build;cd build;cmake .. && make -j PLATFORM=PM3GENERIC && PM3BIN=./proxmark3 ../../tools/pm3_tests.sh client )
  32 ( cd client; rm -rf build; mkdir build;cd build;cmake .. && make -j PLATFORM=PM3RDV4  && PM3BIN=./proxmark3 ../../tools/pm3_tests.sh client )
  33 ( cd client; rm -rf build; mkdir build;cd build;cmake .. && make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS=BTADDON && PM3BIN=./proxmark3 ../../tools/pm3_tests.sh client )
  34 ```
  35
  36 - [ ] RPI Zero
  37 - [ ] WSL
  38 - [ ] PSv3.10
  39 - [ ] Archlinux
  40 - [ ] Kali
  41 - [ ] Debian
  42 - [ ] Ubuntu20
  43 - [ ] ParrotOS
  44 - [ ] Fedora
  45 - [ ] OpenSuse
  46 - [ ] OSX
  47 - [ ] Android
  48 - [ ] Termux
  49
  50 # creating release
  51 `make release RELEASE_NAME="ice awesome"`
  52 last line of output,  gives you next command to run
  53 Sample:  `git push && git push origin v4.15000`
  54
  55 # Step Github releases
  56 Go to Github releases,  create release based on the new created tag and publish
  57
  58 # Step Homebrew updates
  59 update homebrew repo, file `proxmark3.rb` with a SHA256 sum of the file `v4.15000.tar.gz`
  60
  61 # Step package maintains
  62 make a list of new standalone modes,  so when we alert package maintainers they have a sporting chance of adding them