Steps for Making a release of Aztec
This doucment outlines the steps that should be followed for making a release of Aztec 3D Modeller via SourceForge. This doucment was written fo the Win32 platform in mind, so this doucment should be updated when the Linux version of Aztec becomes more mature and in a releasable state.
1. Update aztec/docs/README
The README file is usually the first file that is read, so it must contain up to date information, espcially version numbers, install information, and any known problems at the time that may cause confusion to a user.
2. Write/Update aztec/docs/ReleaseNotes.html
Write a document explaining what is new in the release, and any caveats to look out for.
3. Update aztec/docs/BuildingAztec.html
This file is essential to those that want to build Aztec from the source code. If any of this information is out of date or incorrect, it cause major headaches. For big releases, it is recommended that the release technician does a download of the prepared files, and attempts to build it from sratch. Doing this on a clean machine would be ideal, but that will not always be possible.
4. Update the version number in the GUI
Edit aztec/source/include/AztecVersion.h and change the value for AZTEC_VERSION_NUMBER at around line 48. This is the version number displayed in the title bar, so it is very important to have this right.
5. Do a complete checkout
Do a completely new checkout of the aztec module into a clean area, to make sure what is in the repository is what we want.
6. Do a complete rebuild
Do a COMPLETE rebuild of all configurations, to ensure all components build correctly. Run both Debug and Release versions of AztecMain.exe to ensure that they actually run.
7. Do a final check on all source code
Do a final check on all the source code to ensure that there are no files uncommitted, or edited, missing, or anything else.
8. Edit aztec/docs/changelogs.txt
Edit aztec/docs/changelogs.txt and put a banner indicating the new release version number, and the date it was released.
9. Tag all the modules
Tag all the modules on the appropriate branch that is being released (usually the main trunk) with AZTEC_WIN32_1_1_2 or with whatever version number it is.
10. Prepare the release notes and changelogs
Take the files aztec/docs/README and ztec/docs/ReleaseNotes.html and convert them into plain text, NOT 80 column formatted width. This is done because source forge wants these two files in a nice format. Do not save these into the aztec directory, save them somewhere else!
11. Prepare the aztec-win32 release directory
In an aztec area that has been fully built and confirmed to run, execute "aztec/compile_release bianry <version_number>" to create the binary package.
12. Add MSVCP60.DLL
You must copy the MSVCP60.DLL from either your system or system32 folder to "win32-i386\bin" so aztec can run on computers where this file is not installed.
Do not forget to scan this file for viruses using a well known anti-virus program such as Norton AV or McAfee + latest updates. When you encounter a virus, do NOT just continue with this release! First make sure that your system is totally free of viruses.
13. Prepare the aztec-src release directory
Check out a clean repository, with an export if you wish (although it isn't necessary). Then run "aztec/compile_release source <version_number>" to create the source package
14. Confirm the packages
Zip up the packages, and then unzip them to a new location and attempt to run the executable, and to build the source code, following the isntructions in BuildingAztec.html
15. Build the installer
Use the same files (the ones you didn't execute) to create a special installer version of Aztec using the extended version of Inno Setup 2 and follow the instructions in BuildingInstaller.html
16. Release them on SourceForge!
All systems go!