2020-09-01 01:36:45 +08:00
|
|
|
---
|
|
|
|
|
name: Checklist for release
|
2020-09-01 02:19:46 +08:00
|
|
|
about: A template when making a release (usage reserved to repo maintainers)
|
|
|
|
|
title: "[RELEASE 4.x] Checklist"
|
2020-09-01 01:36:45 +08:00
|
|
|
labels: Release
|
|
|
|
|
assignees: doegox, iceman1001
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2020-09-01 02:19:46 +08:00
|
|
|
# Checklist
|
2020-09-01 01:36:45 +08:00
|
|
|
|
|
|
|
|
- [ ] `make style`
|
2021-09-05 06:54:36 +08:00
|
|
|
- [ ] `make miscchecks`
|
2020-09-01 02:19:46 +08:00
|
|
|
- [ ] `make clean; make client CC=clang CXX=clang++ LD=clang++` on recent Debian or Ubuntu
|
2020-09-01 01:36:45 +08:00
|
|
|
- [ ] `mymanualchecks.sh`
|
|
|
|
|
- [ ] `mycppcheck.sh` no alarming warning?
|
2021-12-13 08:06:29 +08:00
|
|
|
- [ ] `tools/build_all_firmwares.sh` check that the script contains all standalone modes then compile all standalone modes (linux only)
|
2021-09-06 02:34:20 +08:00
|
|
|
- [ ] `experimental_lib` compilation & tests
|
|
|
|
|
- [ ] `experimental_client_with_swig` compilation & tests
|
2021-05-08 03:21:42 +08:00
|
|
|
- [ ] GitHub Actions - green across the board ( MacOS, Ubuntu, Windows)
|
2020-09-01 01:36:45 +08:00
|
|
|
|
2020-09-01 02:19:46 +08:00
|
|
|
# OS compilation and tests
|
2020-09-01 01:36:45 +08:00
|
|
|
|
2023-01-16 01:46:14 +08:00
|
|
|
Run `tools/release_tests.sh` on:
|
2020-09-01 01:36:45 +08:00
|
|
|
|
2020-09-01 02:19:46 +08:00
|
|
|
- [ ] RPI Zero
|
2021-09-04 17:43:51 +08:00
|
|
|
- [ ] Jetson Nano
|
2020-09-01 02:19:46 +08:00
|
|
|
- [ ] WSL
|
2024-02-20 18:11:18 +08:00
|
|
|
- [ ] PSv3.xx
|
2021-06-26 04:43:27 +08:00
|
|
|
- [ ] Archlinux
|
2020-09-01 02:19:46 +08:00
|
|
|
- [ ] Kali
|
2021-09-05 06:09:02 +08:00
|
|
|
- [ ] Debian Stable
|
|
|
|
|
- [ ] Debian Testing
|
2023-01-16 02:40:52 +08:00
|
|
|
- [ ] Ubuntu 22
|
2020-09-01 02:19:46 +08:00
|
|
|
- [ ] ParrotOS
|
2023-01-16 04:53:39 +08:00
|
|
|
- [ ] Fedora 37
|
2021-09-05 06:18:54 +08:00
|
|
|
- [ ] OpenSuse Leap
|
|
|
|
|
- [ ] OpenSuse Tumbleweed
|
2021-12-30 22:12:25 +08:00
|
|
|
- [ ] OSX (MacPorts)
|
|
|
|
|
- [ ] OSX (Homebrew)
|
2020-09-01 02:19:46 +08:00
|
|
|
- [ ] Android
|
2021-05-10 06:11:33 +08:00
|
|
|
- [ ] Termux
|
2021-06-26 05:57:07 +08:00
|
|
|
|
|
|
|
|
# creating release
|
2021-09-19 04:04:55 +08:00
|
|
|
|
2023-11-13 17:54:45 +08:00
|
|
|
- [ ] CHANGELOG.md: add title: `## [myreleasename][YYYY-MM-DD]`
|
|
|
|
|
- [ ] `make release RELEASE_NAME="myreleasename"`
|
|
|
|
|
- last line of output gives you next command to run.
|
2021-12-16 10:25:18 +08:00
|
|
|
- Sample: `git push && git push origin v4.12345`
|
2023-11-13 17:54:45 +08:00
|
|
|
- [ ] CHANGELOG.md: edit title to add version info: `## [myreleasename.4.12345][YYYY-MM-DD]`
|
2021-06-26 05:57:07 +08:00
|
|
|
|
2021-09-04 17:43:51 +08:00
|
|
|
## Step Github releases
|
2021-09-19 04:04:55 +08:00
|
|
|
|
|
|
|
|
- [ ] Go to Github releases, create release based on the new created tag and publish
|
2023-11-13 17:54:45 +08:00
|
|
|
- Choose a tag: v4.12345
|
|
|
|
|
- Target: master
|
|
|
|
|
- Set as the latest release
|
|
|
|
|
- Title: `proxmark3-v4.12345`
|
|
|
|
|
- Description:
|
|
|
|
|
```
|
|
|
|
|
Release v4.12345
|
|
|
|
|
Nickname "myreleasename"
|
|
|
|
|
```
|
2021-09-04 16:20:19 +08:00
|
|
|
|
2021-09-04 17:43:51 +08:00
|
|
|
## Step Homebrew updates
|
2021-09-19 04:04:55 +08:00
|
|
|
|
|
|
|
|
- [ ] update homebrew repo, file `proxmark3.rb`
|
2021-12-16 10:25:18 +08:00
|
|
|
- with a SHA256 sum of the file `v4.12345.tar.gz`
|
2021-09-19 04:04:55 +08:00
|
|
|
- with updated list of standalone modes
|
2021-09-04 16:20:19 +08:00
|
|
|
|
2021-09-04 17:43:51 +08:00
|
|
|
## Step package maintains
|
2021-09-19 04:04:55 +08:00
|
|
|
|
|
|
|
|
- [ ] make a list of new standalone modes, so when we alert package maintainers they have a sporting chance of adding them
|
