cmake-basis / legacy

Legacy CMake BASIS project for versions 3.2 and older. For newer versions, go to
https://github.com/cmake-basis/BASIS
Other
13 stars 11 forks source link

Document how to create betas and releases (for user projects) with basis #470

Closed ahundt closed 9 years ago

ahundt commented 9 years ago

There should be something explaining how to make a release vs beta, including source and pdf, and a . I don't really know how that works. Also, perhaps add a way to include the exact date and time when the release pdf is generated similarly to what is included in the beta pdfs.

Originally mentioned in #399

schuhschuh commented 9 years ago

The differentiation between beta and release is based on the value of the project VERSION in the BasisProject.cmake file. For a release, set it to a valid project version (format major.minor.patch). For a development branch use "0.0.0". For a beta version, I would probably set it to something like "1.0.0b" or "1.0.0rc1". Besides that this info is included as string in the documentation and the --version output of commands that use the BASIS Utilities functions, it has no further meaning.

This info is a bit hidden in the (outdated) Branch and Release guide. An explanation could be added to the Configure a Project how-to guide.

How to generate the manual and/or web pages is explained in the general build instructions and you also added a brief section to in this how-to guide.

Not clear about the timestamp request. I wouldn't include the time itself, the date should be sufficient which is included already. It's quite unlikely and unusual to have multiple releases on the same day and for development builds, when you use either SVN or Git, the revision number should be sufficient to identify the exact project revision.

screen shot 2015-09-14 at 17 02 05

The only difference here when VERSION is "0.0.0" is that instead of the version number underneath the title, you get either the SVN revision number, Git HEAD SHA1, or a build time stamp made up of the date only ("bYYYYMMDD"). The date below the author line is present in both cases. For example, when the source tree is a Git repository:

screen shot 2015-09-14 at 17 13 23
ahundt commented 9 years ago

Cool, perhaps the info should be consolidated somewhere in the docs with a heading to make it easy to find?