Skip to content
Snippets Groups Projects
Commit 2c086ce0 authored by Boris Basic's avatar Boris Basic
Browse files

[doc] Update the SQP to reflect TELEMAC use of semantic versioning

parent ffc5110f
No related branches found
No related tags found
No related merge requests found
\begin{todolist}
\setlength\itemsep{0.01em}
\item Create the branch \textbf{vXpY} from the main.
\item Update the \verb!NEWS.txt!. Replace main section by section
\textbf{vXpY}.
\item Create the branch \textbf{vX.Y} from the main.
\item Update the \verb!NEWS.txt! file. Replace the title of the ``Latest
changes'' section with ``Release \textbf{X.Y.Z} dd/mm/yyyy'', where
``dd/mm/yyyy'' is the release date.
\item In \verb!documentation/data/TelemacDoc.cls! change the command
\verb!\telmaversion! to \textbf{vXpY}.
\verb!\telmaversion! to \textbf{X.Y}.
\item In \verb!sources/utils/special/declarations_special.f! change the
parameter VERSION to \textbf{vXpY}.
\item In \verb!configs/systel.edf.cfg! change version to \textbf{vXpY}.
parameter VERSION to \textbf{X.Y}.
\item In \verb!configs/systel.edf.cfg! change version to \textbf{X.Y}.
\item Run \verb!compile_telemac.py --clean --rescan!. Update cmdf on main if necessary.
\item Run \verb!validate_telemac.py!.
\item Run \verb!validate_telemac.py --notebook --notebook-update!.
......
\begin{todolist}
\setlength\itemsep{0.01em}
\item In the branch \textbf{vXpY} update \verb!NEWS.txt! with release date.
\item In the branch \textbf{vX.Y} update \verb!NEWS.txt! with release date.
\item Rerun Validation, documentation, eficas if some modifications where
done to examples, documentation, dictionaries.
\item Create the tag \textbf{vXpYrZ}.
\item Create the tag \textbf{vX.Y.Z}.
\end{todolist}
......@@ -480,7 +480,7 @@ The creation of the reference version is described here.\\
The \telemacsystem{} version are handled using ``tags''.
\begin{itemize}
\item The creation of a tag is decided by the Chain Handler and the PM\@.
\item Tags are named in the format \textbf{vXpYrZ} where:
\item Tags are named in the format \textbf{vX.Y.Z} where:
\begin{itemize}
\item \textbf{X} is the major version index, incremented when a major
modification is done to the code (ex: makeover of the interface,
......@@ -499,16 +499,16 @@ The versions are divided into branches and tags. There is:
is where the different kind of maintenances are integrated.
Figure~\ref{fig_lifecycle} shows the evolution of the main branch between two
stable versions.
\item \textbf{The version branch} (\textbf{vXpY}), created for each new major
\item \textbf{The version branch} (\textbf{vX.Y}), created for each new major
and minor version release. It is used only for corrective and adaptive
maintenance and has passed the full validation process. A new version branch
is created each year in September.
\item \textbf{The stable version tag} (\textbf{vXpYrZ}), created on
the version branch (\textbf{vXpY}) at each new release. Such a tag is fixed
\item \textbf{The stable version tag} (\textbf{vX.Y.Z}), created on
the version branch (\textbf{vX.Y}) at each new release. Such a tag is fixed
and is never modified afterwards. If a corrective or adaptive maintenance is
necessary, the changes are first made on the main branch and then merged into
the version branch, before the next tag (\textbf{vXpYrZ+1}).
Figure~\ref{fig_lifecycle} shows the creation of a branch \textbf{vXpY} and
the version branch, before the next tag (\textbf{vX.Y.Z+1}).
Figure~\ref{fig_lifecycle} shows the creation of a branch \textbf{vX.Y} and
its corresponding tags. The first tag is created (pending validation) two
months after the creation of the version branch.
\end{itemize}
......@@ -533,7 +533,7 @@ The different versions, major and minor, are separated by a flexible interval:
Finally, at any time we have the following versions:
\begin{itemize}
\item The development version: it is the \textbf{main} branch.
\item The latest stable version \textbf{vXpYrZ}.
\item The latest stable version \textbf{X.Y.Z}.
\end{itemize}
This timetable can be modified due to a big change in the code that would
......@@ -559,8 +559,8 @@ stable version as it should be the most advanced and has the fewest bugs.
\subsection{Checklist for version release}
Here are the actions that need to be done when creating a new version
\textbf{vXpY}\@:
\textbf{X.Y}\@:
\input{latex/checklist_major_release}
Here are the actions that need to be done when creating a new version
\textbf{vXpYrZ}\@:
\textbf{X.Y.Z}\@:
\input{latex/checklist_minor_release}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment