mirror of
https://github.com/RfidResearchGroup/proxmark3.git
synced 2024-09-23 00:37:14 +08:00
80 lines
3.1 KiB
Markdown
80 lines
3.1 KiB
Markdown
---
|
|
name: Checklist for release
|
|
about: A template when making a release (usage reserved to repo maintainers)
|
|
title: "[RELEASE 4.x] Checklist"
|
|
labels: Release
|
|
assignees: doegox, iceman1001
|
|
|
|
---
|
|
|
|
# Checklist
|
|
|
|
- [ ] CHANGELOG.md: add title: `## [releasename][YYYY-MM-DD]`
|
|
- [ ] `make style`
|
|
- [ ] `make miscchecks`
|
|
- [ ] `make clean; make client CC=clang CXX=clang++ LD=clang++` on recent Debian or Ubuntu
|
|
- [ ] `mymanualchecks.sh`
|
|
- [ ] `mycppcheck.sh` no alarming warning?
|
|
- [ ] `tools/build_all_firmwares.sh` check that the script contains all standalone modes then compile all standalone modes (linux only)
|
|
- [ ] `experimental_lib` compilation & tests
|
|
- [ ] `experimental_client_with_swig` compilation & tests
|
|
- [ ] Check Android `CMakeLists.txt` list of source file
|
|
- [ ] GitHub Actions - green across the board ( MacOS, Ubuntu, Windows)
|
|
|
|
# OS compilation and tests
|
|
|
|
```bash
|
|
#!/usr/bin/env bash
|
|
|
|
make clean && make -j PLATFORM=PM3GENERIC PLATFORM_EXTRAS= && tools/pm3_tests.sh --long || exit 1
|
|
make clean && make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS= && tools/pm3_tests.sh --long || exit 1
|
|
make clean && make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS=BTADDON && tools/pm3_tests.sh --long || exit 1
|
|
make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS=BTADDON && sudo make install PLATFORM=PM3RDV4 PLATFORM_EXTRAS=BTADDON && ( cd /tmp; proxmark3 -c 'data load -f lf_EM4x05.pm3;lf search -1'|grep 'Valid FDX-B ID found' ) && sudo make uninstall || exit 1
|
|
|
|
( cd client; rm -rf build; mkdir build;cd build;cmake .. && make -j PLATFORM=PM3GENERIC PLATFORM_EXTRAS= && cp -a ../*scripts ../*libs . && ../../tools/pm3_tests.sh --clientbin $(pwd)/proxmark3 client ) || exit 1
|
|
( cd client; rm -rf build; mkdir build;cd build;cmake .. && make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS= && cp -a ../*scripts ../*libs . && ../../tools/pm3_tests.sh --clientbin $(pwd)/proxmark3 client ) || exit 1
|
|
( cd client; rm -rf build; mkdir build;cd build;cmake .. && make -j PLATFORM=PM3RDV4 PLATFORM_EXTRAS=BTADDON && cp -a ../*scripts ../*libs . && ../../tools/pm3_tests.sh --clientbin $(pwd)/proxmark3 client ) || exit 1
|
|
|
|
# Hitag2crack, optionally with --long and --gpu ...
|
|
make hitag2crack/clean && make hitag2crack && tools/pm3_tests.sh hitag2crack || exit 1
|
|
```
|
|
|
|
- [ ] RPI Zero
|
|
- [ ] Jetson Nano
|
|
- [ ] WSL
|
|
- [ ] PSv3.10
|
|
- [ ] Archlinux
|
|
- [ ] Kali
|
|
- [ ] Debian Stable
|
|
- [ ] Debian Testing
|
|
- [ ] Ubuntu21
|
|
- [ ] ParrotOS
|
|
- [ ] Fedora
|
|
- [ ] OpenSuse Leap
|
|
- [ ] OpenSuse Tumbleweed
|
|
- [ ] OSX (MacPorts)
|
|
- [ ] OSX (Homebrew)
|
|
- [ ] Android
|
|
- [ ] Termux
|
|
|
|
# creating release
|
|
|
|
- [ ] `make release RELEASE_NAME="ice awesome"`
|
|
- last line of output, gives you next command to run.
|
|
- Sample: `git push && git push origin v4.12345`
|
|
- [ ] CHANGELOG.md: edit title to add version info: `## [releasename.4.12345][YYYY-MM-DD]`
|
|
|
|
## Step Github releases
|
|
|
|
- [ ] Go to Github releases, create release based on the new created tag and publish
|
|
|
|
## Step Homebrew updates
|
|
|
|
- [ ] update homebrew repo, file `proxmark3.rb`
|
|
- with a SHA256 sum of the file `v4.12345.tar.gz`
|
|
- with updated list of standalone modes
|
|
|
|
## Step package maintains
|
|
|
|
- [ ] make a list of new standalone modes, so when we alert package maintainers they have a sporting chance of adding them
|