11# Version Update Checklist
22
3+ listing out things to do so i won't forget to do them -persune
4+
35- [ ] Update changelogs:
46 - [CHANGELOG.md](Dn-FamiTracker/CHANGELOG.md), which will update [../Dn-Help/hlp/changelog_shell.htm](changelog_shell.htm) upon build
5- - Categories
6- - `Important changes:`
7- - summary of immediate and obvious changes to the program
8- - `Improvements:`
9- - additions and refactoring
10- - `Bug fixes:`
11- - any bug fixes
12- - `Internal:`
13- - meta changes, including changes regarding to the repository or CI
14- - Format
15- - `<description of singular change> ([issue_author] [commit_author] [#<issue number>] [#<PR number>])`
16- - only put in issue author and number if it exists
17- - only put one author if issue and commit author is the same
18- - sort by category, then by issue number, then by PR number
19- - ex:
20- - `Fix access violation in MRU submenu list update (@eugene-s-nesdev @Gumball2415 #243 #214)`
21- - [ ] Create Version Tag
22- - Format: `Dnx.y.z.b`
23- - x: Major (API change)
24- - y: Minor (backward compatible change)
25- - z: Patch (backward compatible bugfix)
26- - b: Build type (internal, not visible)
27- - 0: stable release
28- - 9: "dirty"/beta/in-development build
29- - Double check that this tag is higher than the previous release tag
30- - Version tag must be appropriate to Semantic Versioning
31- - [ ] Edit every file with version info:`
32- - [version.h](../version.h)
33- - [Dn-FamiTracker.rc](../Dn-FamiTracker.rc) gets its version constants from here
34- - [Readme.txt](../Readme.txt)
35- - [ ] ** IMPORTANT** : update ConfigVersion.cpp
7+ - see [changelog format](changelog_format.md)
368- [ ] Update copyright years:
379 - Update License years in
3810 - [LICENSE.md](../LICENSE.md)
4113
4214```
4315Dn-FamiTracker - NES/Famicom sound tracker
44- Copyright (C) 2020-2025 D.P.C.M.
16+ Copyright (C) 2020-2026 D.P.C.M.
4517FamiTracker Copyright (C) 2005-2020 Jonathan Liss
46180CC-FamiTracker Copyright (C) 2014-2018 HertzDevil
4719
@@ -60,6 +32,22 @@ along with this program. If not, see https://www.gnu.org/licenses/.
6032```
6133
6234- [ ] *** important*** : set date of release at the last moment!
35+ - [ ] Create Version Tag
36+ - Format: `Dnx.y.z.b`
37+ - x: Major (API change)
38+ - y: Minor (backward compatible change)
39+ - z: Patch (backward compatible bugfix)
40+ - b: Build type (internal, not visible)
41+ - 0: stable release
42+ - 9: "dirty"/beta/in-development build
43+ - Double check that this tag is higher than the previous release tag
44+ - Version tag's first three digits must be appropriate to Semantic Versioning
45+ - [ ] Edit every file with version info:`
46+ - [version.h](../version.h)
47+ - [Dn-FamiTracker.rc](../Dn-FamiTracker.rc) gets its version constants from here through a build script
48+ - [Readme.txt](../Readme.txt)
49+ - [ ] ** IMPORTANT** : update ConfigVersion.cpp
50+ - [ ] [ Dn-help update] ( ../Dn-help/version_update.md )
6351- [ ] Create and push Version Tag to the repo
6452 - There is a GitHub Actions script to build a drafted release upon a tag push
6553 - Tag must be on commit deemed appropriate for release
0 commit comments