<title>Release Procedures</title>
<a name="releaseProcedures"></a>
<h2>Release Procedures</h2>
<p>
Follow these steps to prepare a new release of System.Data.SQLite.
Unless otherwise noted, all steps need to be done in the order specified.
</p>
<a name="buildBinaries"></a>
<h2>Build x86 & x64 Binaries</h2>
<ol>
<li>
The binaries for all supported architectures and platforms must be built
using procedures very similar to those documented in the normal
[./build.wiki | build procedures].
</li>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the x86 and x64 binaries:
<b>build_all.bat</b><br />
</li>
</ol>
<a name="testBinaries"></a>
<h2>Test x86 & x64 Binaries</h2>
<ol>
<li>
The binaries for all supported architectures and platforms must be tested
using procedures very similar to those documented in the normal
[./test.wiki | test procedures].
</li>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to test all the x86 or x64 binaries, depending
on the processor architecture of the current machine:
<b>test_all.bat</b><br />
</li>
<li>
Locate a machine with a processor architecture different from the one tested
in the previous step and then repeat all the previous steps.
</li>
</ol>
<a name="buildCeBinaries"></a>
<h2>Build Windows CE Binaries</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the binaries available for Windows
CE: <b>build_ce.bat</b><br />
</li>
</ol>
<a name="testCeBinariesAutomated"></a>
<h2>Test Windows CE Binaries via Automation</h2>
<ol>
<li>
Intead of testing the Windows CE binaries
<a href="#testCeBinariesManually">manually</a> as described in the next
section, the following steps may be used.
</li>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to test all the binaries available for Windows
CE: <b>test_ce.bat</b><br />
</li>
</ol>
<a name="testCeBinariesManually"></a>
<h2>Test Windows CE Binaries Manually</h2>
<ol>
<li>
If the Windows CE binaries were already tested using the
<a href="#testCeBinariesAutomated">automation</a> described in the previous
section, skip this section.
</li>
<li>
Launch <b>Visual Studio 2008</b>, "<b>Professional</b>" edition or
"better". As of this writing, in January 2012, <b>Visual Studio
2010 and later will not work</b> as they do not include the necessary
built-in support for Windows CE and the .NET Compact Framework.
</li>
<li>
Open the "<b>SQLite.NET.2008.sln</b>" solution file in the
"<root>" directory.
</li>
<li>
Change the active solution configuration to "<b>Debug</b>".
</li>
<li>
Change the active solution platform to "<b>Pocket PC 2003
(ARMV4)</b>".
</li>
<li>
Right-click the "<b>testce</b>" project in the Solution Explorer
window and select "<b>Set as StartUp Project</b>".
</li>
<li>
Select "<b>Start Debugging</b>" from the "<b>Debug</b>"
menu.
</li>
<li>
If any rebuild prompts appear (e.g. "<b>SQLite.Interop.CE.2008</b>",
"<b>Would you like to build it?</b>"), select "<b>Yes</b>".
</li>
<li>
When prompted for the device type to deploy the application to, select the
"<b>Pocket PC 2003 SE Emulator</b>" device.
</li>
<li>
Make sure all that the tests pass (i.e. they emit "<b>SUCCESS</b>").
</li>
</ol>
<a name="updateDocumentation"></a>
<h2>Update Documentation</h2>
<ol>
<li>
Update the "<root>\readme.htm" file with information about
all the major changes since the last released version.
</li>
<li>
Copy those changes to the "<root>\Doc\Extra\version.html"
and "<root>\www\news.wiki" files, reformatting as necessary
to fit with the existing document conventions.
</li>
</ol>
<a name="buildDocumentation"></a>
<h2>Build Documentation</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Doc".</li>
<li>
Enter the following command to build all the documentation in
[http://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help | CHM]
format: <b>tclsh.exe buildChm.tcl</b><br /><i>This assumes that
[http://www.activestate.com/activetcl | ActiveTcl] version 8.4 or later, the
[http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=21138 | HTML Help Workshop],
and [http://ndoc3.sourceforge.net/ | NDoc3] have all been installed using
the default settings.</i>
</li>
</ol>
<a name="buildSetupPackages"></a>
<h2>Build Setup Release Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the setup packages for x86 and
x64: <b>bake_all.bat</b><br />
</li>
</ol>
<a name="buildBinaryPackages"></a>
<h2>Build x86 & x64 Binary Release Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the binary release packages for
x86 and x64: <b>release_all.bat</b><br />
</li>
</ol>
<a name="buildStaticBinaryPackages"></a>
<h2>Build x86 & x64 Static Binary Release Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the static binary release packages
for x86 and x64: <b>release_static.bat</b><br />
</li>
</ol>
<a name="buildCeBinaryPackages"></a>
<h2>Build Windows CE Binary Release Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the binary release packages for
Windows CE: <b>release_ce.bat</b><br />
</li>
</ol>
<a name="buildSourcePackages"></a>
<h2>Build Source Release Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the source release packages:
<b>archive.bat</b><br />
</li>
</ol>
<a name="verifyAllPackages"></a>
<h2>Verify All Release Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Enter the following command to build all the source release packages:
<b>..\Externals\Eagle\bin\EagleShell.exe -file verify.eagle Output</b><br />
<i>If errors are generated, the file "<root>\Setup\verify.lst"
may need to be updated to account for the files that have been added and/or
removed from the release archives since the previous release.</i>
</li>
</ol>
<a name="buildNuGetPackages"></a>
<h2>Build NuGet Packages</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>".</li>
<li>
Enter the following command to build the "default" NuGet package:
<b>nuget.exe pack SQLite.nuspec</b><br /><i>This assumes
that the NuGet binary is available somewhere along the
[http://en.wikipedia.org/wiki/PATH_%28variable%29 | PATH].<br />Please refer
to [http://docs.nuget.org/ | NuGet Documentation] for further details.</i>
</li>
<li>
Enter the following command to build the "managed-only" NuGet
package: <b>nuget.exe pack SQLite.MSIL.nuspec</b><br />
<i>This assumes that the NuGet binary is available somewhere along the
[http://en.wikipedia.org/wiki/PATH_%28variable%29 | PATH].<br />Please refer
to [http://docs.nuget.org/ | NuGet Documentation] for further details.</i>
</li>
<li>
Enter the following command to build the NuGet package for x86:
<b>nuget.exe pack SQLite.x86.nuspec</b><br /><i>This assumes that
the NuGet binary is available somewhere along the
[http://en.wikipedia.org/wiki/PATH_%28variable%29 | PATH].<br />Please refer
to [http://docs.nuget.org/ | NuGet Documentation] for further details.</i>
</li>
<li>
Enter the following command to build the NuGet package for x64:
<b>nuget.exe pack SQLite.x64.nuspec</b><br /><i>This assumes
that the NuGet binary is available somewhere along the
[http://en.wikipedia.org/wiki/PATH_%28variable%29 | PATH].<br />Please refer
to [http://docs.nuget.org/ | NuGet Documentation] for further details.</i>
</li>
<li>
Enter the following command to move the NuGet packages to the release output
directory:
<b>move *.nupkg Setup\Output</b>
</li>
</ol>
<a name="updateDownloadsPage"></a>
<h2>Update Downloads Page</h2>
<ol>
<li>Open a normal command prompt window with "cmd.exe".</li>
<li>Change the current directory to "<root>\Setup".</li>
<li>
Replace the version numbers for the previous release in the local working
copy of the [./downloads.wiki | downloads page] with the new version numbers
for System.Data.SQLite and the SQLite core.
</li>
<li>
Enter the following command to update the sizes and hashes on the downloads
page based on all the built release packages: <b>tclsh.exe
updateFileInfo.tcl</b><br /><i>This assumes that
[http://www.activestate.com/activetcl | ActiveTcl] version 8.4 or later has
been installed using the default settings and that the Fossil binary is
available somewhere along the
[http://en.wikipedia.org/wiki/PATH_%28variable%29 | PATH] (i.e. for
calculating the SHA1 hashes).</i>
</li>
</ol>
<a name="publishRelease"></a>
<h2>Publish Release</h2>
<ol>
<li>
Commit pending source code changes to the
[http://www.fossil-scm.org/ | Fossil] repository.
</li>
<li>Tag the release in the Fossil repository.</li>
<li>Upload all the release packages to the web site.</li>
<li>
Push the [http://www.nuget.org/ | NuGet] packages.<br />
<i>Please refer to [http://docs.nuget.org/ | NuGet Documentation] for
further details.</i>
</li>
<li>Announce the release on the System.Data.SQLite mailing list.</li>
</ol>
