Release Process

From Sailcut

Jump to: navigation, search

Every Sailcut CAD release should be performed as described here.

Contents

Checks

Check that it works!

This cannot be over-emphasized. Before making a release check that the following tests pass.

  • basic checks:
    • launch Sailcut
    • check that the default sail is ok (3D view, wireframe view, developed view)
  • file save/load:
    • launch Sailcut
    • make changes to the sail (for instance a jib) and check that all views are updated correctly
    • save the file
    • close Sailcut
    • launch Sailcut
    • load the file you saved and check that all views are updated correctly

Check the documentation

Check the following:

  • is the ChangeLog file up to date?
  • is the copyright date in README file up to date?
  • is the copyright in the AUTHORS file up to date?
  • is the project version number in CMakeLists.txt file up to date?
  • is the project version number in the documentation up to date?
  • is the copyright date in Debian/copyright up to date?

Check all changes are commited

Make sure all your changes have been committed to the Subversion repository.


Build the release files

Build the Windows release

On a Linux machine, from your sailcut working directory, run: 

mkdir build-win32
cd build-win32
cmake -DCMAKE_TOOLCHAIN_FILE=../mingw32.toolchain -DSHIP_DEPENDS_ENABLED=TRUE ..
make
cpack -G ZIP
cpack -G NSIS

This will produce:

  • sailcut-x.y.z-win32.zip: zip archive for Windows
  • sailcut-x.y.z-win32.exe: installer for Windows

Test the resulting files on a Windows machine.

Build the Mac OS X release

On a Mac OS X machine, from your sailcut working directory, run: 

mkdir build
cd build
cmake -DSHIP_DEPENDS_ENABLED=TRUE ..
make
cpack -G Bundle

This will produce:

  • sailcut-x.y.z-Darwin.dmg: an image file for Mac OS X

Test the resulting file on a Mac OS X.

Build the source release

From your sailcut working directory, run: 

 svn export . sailcut-x.y.z

This will create a sailcut-x.y.z subdirectory containing a clean copy of the code, without the .svn subdirectories.

You can then create the compressed archive containg the source code by running the following: 

 tar czvf sailcut-x.y.z.tar.gz sailcut-x.y.z

This will produce:

  • sailcut-x.y.z.tar.gz: with the source code

Build the Debian package release (NEEDS UPDATING)

On a Linux Debian machine, from the directory where you checked out the release run:

Tag the release

Once you have successfully created and tested all the release files, you can create a "tag" on the release, which captures the state of the source code at the moment the release was made. Run (replace x.y.z by appropriate numbering like 1.3.4): 

 svn cp https://sailcut.svn.sourceforge.net/svnroot/sailcut/trunk https://sailcut.svn.sourceforge.net/svnroot/sailcut/tags/x.y.z

This will open a "vi" window and you need to enter some useful comment in the first line above "This line and below will be ignored...". Once text entered type: 

 Esc key, then 
 :wq to save the file.

Publish the release (NEEDS UPDATING)

Putting the files online

Upload all the files on https://frs.sourceforge.net/webupload

Create the release:

  • Add a new release called "Sailcut CAD x.y.z" on the 
 project's release page.
  • Set the following:
    • Status: hidden
    • Upload Change Log: give the ChangeLog file
    • Notes: (replace x.y.z) 
 Sailcut CAD x.y.z is an updated release of the Sailcut CAD
 sail design package.

 Please refer to the ChangeLog for the list of changes.
    • Preserve my pre-formatted text: true
    • Press Submit/Refresh
  • Add files to the release
    • Tick all the files that make up the release
    • Press Add files
    • For each file:
      • Fill in Processor and Type fields
      • Press Update/Refresh

Communication

Retrieved from "http://www.sailcut.com/Release_Process"
Personal tools