Nort User Manual: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
Line 6: Line 6:


<blockquote style="background-color: #f9f9f9; border: solid thin lightgrey;">
<blockquote style="background-color: #f9f9f9; border: solid thin lightgrey;">
:[[Nova Ordis Release Tools User Manual - Concepts|Concepts]]
:[[nort Concetps|Concepts]]
</blockquote>
</blockquote>


Line 21: Line 21:
=<tt>release</tt>=
=<tt>release</tt>=


The command queries or modifies release information metadata for the current work area and performs the sequence of steps required to do a release. For more details about what a release is, and what those steps are, see the "[[Nova_Ordis_Release_Tools_User_Manual_-_Concepts#Release|Release]]" section.  
The command queries or modifies release information metadata for the current work area and performs the sequence of steps required to do a release. For more details about what a release is, and what those steps are, see the "[[nort Concepts#Release|Release]]" section.  


To query the work area and display the [[Nova_Ordis_Release_Tools_User_Manual_-_Concepts#Current_Version|current version]], execute:
To query the work area and display the [[nort Concepts#Current_Version|current version]], execute:


<pre>
<pre>
Line 29: Line 29:
</pre>
</pre>


To initiate a [[Nova_Ordis_Release_Tools_User_Manual_-_Concepts#The_Release_Sequence|release sequence]], use:
To initiate a [[nort Concepts#The_Release_Sequence|release sequence]], use:


<pre>
<pre>
Line 35: Line 35:
</pre>
</pre>


For more details on what a release sequence does, see the "[[Nova_Ordis_Release_Tools_User_Manual_-_Concepts#The_Release_Sequence|Release Sequence]]" section.
For more details on what a release sequence does, see the "[[nort Concepts#The_Release_Sequence|Release Sequence]]" section.


<font color=red>If a custom release string is used, the string is checked for consistency. The release process will fail if the version string is invalid or represents an older version than the current.</font>
<font color=red>If a custom release string is used, the string is checked for consistency. The release process will fail if the version string is invalid or represents an older version than the current.</font>
Line 55: Line 55:
=<tt>build</tt>=
=<tt>build</tt>=


The command creates releasable artifacts (binary distributions or libraries, depending on the nature of the project) for the [[Nova_Ordis_Release_Tools_User_Manual_-_Concepts#Current_Version|current version]]. If the build process is successful, the artifacts are stored in the build area ("target" directory, for Maven) of the current work area.
The command creates releasable artifacts (binary distributions or libraries, depending on the nature of the project) for the [[nort Concepts#Current_Version|current version]]. If the build process is successful, the artifacts are stored in the build area ("target" directory, for Maven) of the current work area.


=<tt>install</tt>=
=<tt>install</tt>=
Line 66: Line 66:
For more details on new project initialization see:
For more details on new project initialization see:
<blockquote style="background-color: #f9f9f9; border: solid thin lightgrey;">
<blockquote style="background-color: #f9f9f9; border: solid thin lightgrey;">
:[[Nova_Ordis_Release_Tools_User_Manual_-_Concepts#New_Project_Initialization|New Project Initialization]]
:[[nort Concepts#New_Project_Initialization|New Project Initialization]]
</blockquote>
</blockquote>

Revision as of 21:11, 26 November 2016

Internal

Concepts

Concepts

Global Options

-v|--verbose

Enable verbose execution

-d|--debug

Starts the JVM in debug mode.

release

The command queries or modifies release information metadata for the current work area and performs the sequence of steps required to do a release. For more details about what a release is, and what those steps are, see the "Release" section.

To query the work area and display the current version, execute:

release info

To initiate a release sequence, use:

release major|minor|patch|snapshot|<custom-release-string>

For more details on what a release sequence does, see the "Release Sequence" section.

If a custom release string is used, the string is checked for consistency. The release process will fail if the version string is invalid or represents an older version than the current.

release Command Options

--no-tests

won't run the test suite upon release. Not usually recommended, unless we're releasing a snapshot.

--no-push

If this flag is used, there won't be any attempt to push any changes (artifacts or source code) to remote repositories. The artifacts will be built and published in the local artifact repository. The code changes will be committed and tagged in the local source repository only.

This option is useful when the release process takes places off-line.

Clarify the situation when we want to push those artifacts later.

build

The command creates releasable artifacts (binary distributions or libraries, depending on the nature of the project) for the current version. If the build process is successful, the artifacts are stored in the build area ("target" directory, for Maven) of the current work area.

install

nort initialize

Initializes a new project.

For more details on new project initialization see:

New Project Initialization