Files
proxmark3/.github/ISSUE_TEMPLATE/checklist-for-release.md
2026-09-17 22:48:34 +02:00

84 lines
2.4 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
- [ ] `make style`
- [ ] `make miscchecks`
- [ ] `make clean; make -j host 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
- [ ] `make hitag2crack && tools/pm3_tests.sh hitag2crack --long --opencl`
- [ ] GitHub Actions - green across the board ( MacOS, Ubuntu, Windows)
# OS compilation and tests
Run `tools/release_tests.sh` on:
- [ ] RPI Zero
- [ ] WSL
- [ ] ProxSpace v3.xx
- via Docker
- [ ] Archlinux
- [ ] Debian Stable
- [ ] Debian Stable arm64
- [ ] Debian Stable armhf
- [ ] Debian Testing
- [ ] Fedora 42 (till 2026-05-13)
- [ ] Fedora 43 (till 2026-12-02)
- [ ] Kali
- [ ] OpenSuse Leap
- [ ] OpenSuse Tumbleweed
- [ ] ParrotOS
- [ ] Ubuntu 24.04 (LTS)
- [ ] Ubuntu 25.04
- [ ] Ubuntu 25.10
- [ ] OSX (MacPorts)
- [ ] OSX (Homebrew)
- [ ] Termux cf `docker/termux-README.md`
- [ ] Android cmake cross-compilation ?
# creating release
- [ ] CHANGELOG.md: add title: `## [myreleasename][YYYY-MM-DD]` and push to repo.
- [ ] `make release RELEASE_NAME="myreleasename"`
- 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: `## [myreleasename.4.12345][YYYY-MM-DD]` push to repo.
## Step Github releases
- [ ] Go to Github releases, create release based on the new created tag and publish
- Choose a tag: v4.12345
- Target: master
- Set as the latest release
- Title: `proxmark3-v4.12345`
- Description:
```
Release v4.12345
Nickname "myreleasename"
## CHANGELOG - [myreleasename][YYYY-MM-DD]
< paste relevant part from CHANGELOG file here >
```
## 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