Nort Concepts
Internal
Overview
Release
A NORT release consists in a sequence of interactions with the local project work area, the build system metadata, and various external source code and binary repositories. All types of releases end with the creation of a set of valid release artifacts and the publishing of the artifacts into their corresponding repositories. At the end of the release process, the work area is automatically updated to support the development iteration for the next release.
Release Types
Major
Minor
Patch
Snapshot
Custom
For syntax details see the release command.
The Release Sequence
The release sequence consists in the following steps:
- The local workarea version metadata is tentatively incremented according to the rules described in the "Release Types" section.
- All tests are executed, with the new version metadata in place.
- If at least one test fails, NORT restores the previous release metadata state, reports and fails. The work area is restored to the exact state it was found before the release sequence was initiated.
- If all tests pass, the artifacts corresponding to the release are built and installed in the corresponding artifact repositories. Usually, JARs are installed under their corresponding artifact directories and binary releases are installed under their corresponding "release" modules, both in the local Maven repository. For more details about artifacts and what repositories are they installed into, see "Release Artifacts" section.
- The "install" command is automatically executed, unless "release" command was configured to stop after execution.
If all tests succeed what now?
Release Artifacts
A release my produce one of the following artifact types:
JAR Libraries
Binary Distributions
Binary distributions are usually ZIP file containing everything an application needs in order to be installed on a new system. The binary distribution include libraries, wrapper scripts, release notes, documentation and possibly other artifacts.
The recommended technique to build complex binary distributions is to add a dedicated "release" module to the project and let the Maven assembly plug-in to handle the process. The details are described in the "Building a Maven Complex Release Artifact" article.
If a project has a binary distribution that is built by Maven, NORT will publish it in the local Maven repository, under the "release" module of the project.
Binary distributions may be built using a mechanism different from Maven, but irrespective to how the artifact is built, the release sequence ends in its publishing them in some form of local binary repository.
Current Version
The Installation Sequence
New Project Initialization
The command that carries out a new project initialization is nort initialize.
TODO:
- Verify that the POM of the new project contains the definition of maven.build.timestamp.format and release_date, as required by "Nova Ordis Utilities Version Metadata Handling" instructions. If it does not, inject it.