|
| 1 | +# Version Update Checklist |
| 2 | + |
| 3 | +- [ ] Create Version Tag |
| 4 | + - Format: `Dnx.y.z.r` |
| 5 | + - x: Major (API change) |
| 6 | + - y: Minor (backward compatible change) |
| 7 | + - z: Patch (backward compatible bugfix) |
| 8 | + - r: Revision (backward compatible quick fixes for typos) |
| 9 | + - Double check that this tag is higher than the previous release tag |
| 10 | + - Version tag must be appropriate to Semantic Versioning |
| 11 | +- [ ] Update changelogs: |
| 12 | + - [CHANGELOG.md](CHANGELOG.md), which will update [../Dn-Help/hlp/changelog_shell.htm](changelog_shell.htm) upon build |
| 13 | +- [ ] Edit every file with version info: |
| 14 | + - [Dn-FamiTracker.rc](../Dn-FamiTracker.rc) |
| 15 | + - [version.h](../version.h) |
| 16 | +- [ ] **IMPORTANT**: update ConfigVersion.cpp |
| 17 | +- [ ] Update copyright years: |
| 18 | + - [LICENSE.txt](../LICENSE.txt) |
| 19 | + - all source files with copyright info: |
| 20 | + |
| 21 | +``` |
| 22 | +FamiTracker - NES/Famicom sound tracker |
| 23 | +Copyright (C) 2005-2020 Jonathan Liss |
| 24 | +
|
| 25 | +0CC-FamiTracker is (C) 2014-2018 HertzDevil |
| 26 | +
|
| 27 | +Dn-FamiTracker is (C) 2020-2024 D.P.C.M. |
| 28 | +
|
| 29 | +This program is free software; you can redistribute it and/or modify |
| 30 | +it under the terms of the GNU General Public License as published by |
| 31 | +the Free Software Foundation; either version 2 of the License, or |
| 32 | +(at your option) any later version. |
| 33 | +
|
| 34 | +This program is distributed in the hope that it will be useful, |
| 35 | +but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 36 | +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 37 | +Library General Public License for more details. To obtain a |
| 38 | +copy of the GNU Library General Public License, write to the Free |
| 39 | +Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 40 | +
|
| 41 | +Any permitted reproduction of these routines, in whole or in part, |
| 42 | +must bear this legend. |
| 43 | +``` |
| 44 | + |
| 45 | +- [ ] Create and push Version Tag to the repo |
| 46 | + - There is a GitHub Actions script to build a drafted release upon a tag push |
| 47 | + - Tag must be on commit deemed appropriate for release |
| 48 | +- [ ] Edit and publish the draft release page in GitHub |
| 49 | + - [ ] Triple check that the tag on the release matches the Version Tag |
| 50 | + - [ ] Double check the build artifacts to be accurate and working |
| 51 | +- [ ] Notify everyone about the new version |
0 commit comments