Difference between revisions of "Naming Conventions for Prokee Software Packages"
(Created page with "== Version Strings == The version string of a module (or software package) is a concatenation of two strings, the ''Branch Version'' and the ''Build Version''. == Branch Name...") |
(→Baseman Packages) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
The version string of a module (or software package) is a concatenation of two strings, the ''Branch Version'' and the ''Build Version''. | The version string of a module (or software package) is a concatenation of two strings, the ''Branch Version'' and the ''Build Version''. | ||
| − | == Branch | + | == Branch Version (Branch Name) == |
The ''Branch Version'' is used to specify a branch of development. | The ''Branch Version'' is used to specify a branch of development. | ||
If the term "version" is used, it usually referres to the branch version of a module (or software package). | If the term "version" is used, it usually referres to the branch version of a module (or software package). | ||
| Line 11: | Line 11: | ||
The name of a version can be any string. | The name of a version can be any string. | ||
Commonly used version names are "v01", "v02" and so on. | Commonly used version names are "v01", "v02" and so on. | ||
| − | Increasing numbers do not | + | Increasing numbers do not necessarily correspond to any chronological order. |
| − | Different versions | + | Different versions may provide completely different functionality and my be developed in parallel. |
== Build Version == | == Build Version == | ||
| Line 53: | Line 53: | ||
For baseman packages the version within baseman (here "v01") corresponds with the branch version string of the package. | For baseman packages the version within baseman (here "v01") corresponds with the branch version string of the package. | ||
| − | + | Each baseman package contains the latest available version of source files (within the regarded branch of development) at the time the package has been created. | |
| + | Baseman packages may be updated at any time by replacing older versions. | ||
=== Other Software Packages === | === Other Software Packages === | ||
Other software packages may be named differently. Naming information is usually provided within the documentation. | Other software packages may be named differently. Naming information is usually provided within the documentation. | ||
Latest revision as of 10:24, 17 July 2019
Contents
Version Strings
The version string of a module (or software package) is a concatenation of two strings, the Branch Version and the Build Version.
Branch Version (Branch Name)
The Branch Version is used to specify a branch of development. If the term "version" is used, it usually referres to the branch version of a module (or software package).
While development progresses, the version (Branch Version) of a software package remains the same. When a package is referred to by its version, than the latest available release or state of that package is meant.
The name of a version can be any string. Commonly used version names are "v01", "v02" and so on. Increasing numbers do not necessarily correspond to any chronological order. Different versions may provide completely different functionality and my be developed in parallel.
Build Version
Development Releases
The Build Version of development releases is a string starting with the character "b". A development release is a release that is provided for testing and development purposes. These releases are not intended to be deployed on a production system. Different development releases may have the same build version. E.g. most development releases of prokee modules have the build version "b001". Every new release with the same build version replaces the previous release. Older development releases are not archived. It may be impossible to reconstruct older versions. When working with development releases, only the most recent release of a module (or software package) should be used.
Archived Releases
The Build Version of archived releases is a string starting with the character "a". Archived releases are releases that will not be changed (in contrast to development releases). When a software requires a specific release version of a software package, it should always state the build version of an archived release.
Filenames of Software Packages
Binary Packages of Prokee Modules
The filename is constructed of three parts deliminated by a "-" character.
E.g. baseman.v01-v01b001-linux32.tar.gz.
baseman.v01: The first part names the module (here "baseman") and its branch version (here "v01").v01b001: The second part states the full version string (here "v01" for the branch version and "b001" for the build version).linux32: The third part specifies the platform (operating system and architecture).
Source Code Packages of Prokee Modules
Source code packages are named similar to binary packages. E.g. baseman.v01-v01a001-source.tar.gz.
Source code packages are mainly provided for documentation purposes. The most recent source code can be retrieved from a repository or as a package for baseman (see below).
Baseman Packages
The filename of a baseman package is derived from the path to the package within baseman.
E.g. the base64/cli package may have the following path within baseman: @1:/prokee/mods/base64/cli/v01.
By skipping @1:/ and replacing all occurrences of "/" with "--" a unique filename may look like this: prokee--mods--base64--cli--v01.tar.gz.
For baseman packages the version within baseman (here "v01") corresponds with the branch version string of the package. Each baseman package contains the latest available version of source files (within the regarded branch of development) at the time the package has been created. Baseman packages may be updated at any time by replacing older versions.
Other Software Packages
Other software packages may be named differently. Naming information is usually provided within the documentation.
