% !TEX encoding = UTF-8 Unicode
% !TEX spellcheck = en_US
\documentclass[a4paper, 11pt]{article}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{lmodern}
\usepackage[margin=2.4cm]{geometry} % warning: space added line 238.
\usepackage{enumitem}
\usepackage{fancyhdr}
\usepackage{lastpage}
\usepackage{hyperref}
\usepackage{color}
\usepackage{indentfirst}
% Specific commands
\newcommand{\FullSWOFnD}{\emph{FullSWOF\_1D/2D}}
\newcommand{\FullSWOFoneD}{\emph{FullSWOF\_1D}}
\newcommand{\FullSWOFtwoD}{\emph{FullSWOF\_2D}}
\newcommand{\FullSWOFUI}{\emph{FullSWOF\_UI}}
\newcommand{\SWASHES}{\emph{SWASHES}}
\newcommand{\contactFullName}{Frédéric \textsc{Darboux}}
\newcommand{\contactEmail}{\href{mailto:Frederic.Darboux@oinrae.fr}{Frederic.Darboux@inrae.fr}}
\newcommand{\contactFS}{\href{mailto:fullswof.contact@listes.univ-orleans.fr}{fullswof.contact@listes.univ-orleans.fr}}
\newcommand{\contactSWASHES}{\href{mailto:swashes.contact@listes.univ-orleans.fr}{swashes.contact@listes.univ-orleans.fr}}
\newcommand{\MainWebSiteFSoneD}{\url{https://sourcesup.renater.fr/projects/fullswof-1d/}}
\newcommand{\MainWebSiteFStwoD}{\url{https://sourcesup.renater.fr/projects/fullswof-2d/}}
\newcommand{\MainWebSiteFSUI}{\url{https://sourcesup.renater.fr/projects/fullswof-ui/}}
\newcommand{\MainWebSiteSWASHES}{\url{https://sourcesup.renater.fr/projects/swashes/}}
\renewcommand{\thesection}{\thepart .\arabic{section}}
% Headers and footers
\lhead{Releasing \FullSWOFnD{}, \FullSWOFUI{} or \SWASHES{}}
\rhead{INRAE --- MAPMO}
\cfoot{\thepage /\pageref{LastPage}}
\pagestyle{fancy}
\def\thepart{\Alph{part}}
% Lists: no spacing between items
\setlist{noitemsep}
\title{Documentation:\\
Steps to release a new version of\\
\FullSWOFoneD, \FullSWOFtwoD{}, \FullSWOFUI{} or \SWASHES{}.\\
General release and Windows release}
\author{\contactFullName, \contactEmail}
\date{2020-07-09}
\begin{document}
\maketitle
\thispagestyle{fancy}
This document lists the steps to release a new version of \FullSWOFoneD, \FullSWOFtwoD{}, \FullSWOFUI{} or \SWASHES{}. The first part is related to the general release, \emph{i.e.}~the non-OS-specific packages. The second part describes the release of packages dedicated to Windows.
For any question, please contact us at the following addresses: \contactFS{} or \contactSWASHES{}.
\part{For general release}
Releasing non-OS-specific packages for a new version of \FullSWOFoneD, \FullSWOFtwoD{}, \FullSWOFUI{} or \SWASHES{} requires a succession of operations using various tools.
This part details these steps.
\section{From trunk to tag}
\emph{Remark: it is assumed that you have already downloaded the subdirectories named trunk, tags and branches from the repository.}
After thorough checks (esp.\ compilation and run of the benchmarks under various operating systems), it can be decided to release a new version of the software. A final revision change should be committed to SVN\@. It consists in:
\begin{enumerate}
\item adding to the file trunk/changelog.txt something like:
\begin{verbatim}
2013-09-04
READY FOR TAG version 1.04.04
\end{verbatim}
\item running the script UpdateDateVersion.sh from the trunk directory with parameters such as
\begin{verbatim}
bin/UpdateDateVersion.sh 2013-09-04 1.04.04
\end{verbatim}
\item committing these changes to the SVN server:
\begin{verbatim}
svn commit -m "Ready for tag version 1.04.04"
\end{verbatim}
\item creating the tag:
\begin{verbatim}
svn copy --username USERNAME \
https://subversion.renater.fr/authscm/USERNAME/svn/fullswof-2d/trunk \
https://subversion.renater.fr/authscm/USERNAME/svn/fullswof-2d/tags/release-1.04.04 \
-m "Tagging the 1.04.04 release of FullSWOF_2D project."
\end{verbatim}
\end{enumerate}
\section{From tag to package}
\begin{enumerate}
\item Move in the tags directory and do an update:
\begin{verbatim}
cd tags/
svn update
\end{verbatim}
\item copy the relevant tag directory and give it the corresponding name:
\begin{verbatim}
mkdir FullSWOF_2D-1.04.04
cp -r release-1.04.04/* FullSWOF_2D-1.04.04
\end{verbatim}
\item remove the .svn directories
\begin{verbatim}
find FullSWOF_2D-1.04.04 -name ".svn" -type d -exec rm -rf {} \;
\end{verbatim}
\item create the zip file for \FullSWOFoneD, \FullSWOFtwoD{},\FullSWOFUI{} and \SWASHES{}
\begin{verbatim}
zip -r FullSWOF_2D-1.04.04.zip FullSWOF_2D-1.04.04
\end{verbatim}
\item create a text file (\emph{e.g.}~comment.txt) with some info such as
\begin{verbatim}
FullSWOF_2D release 1.04.04
File type: Source .zip
Processor type: Any
Release Notes:
FullSWOF_2D release 1.04.04
This is a major update introducing new features.
It also includes bug fixes.
Change Log:
Main changes:
- add of infiltration
- add of rain
For details see file changelog.txt
Preserve my pre-formatted text: YES
\end{verbatim}
\item Click on ``Create release''.
\end{enumerate}
\color[gray]{0.4}
\item In case of \FullSWOFUI{}, add the jar file in the Release file:
\begin{enumerate}
\item Go to the project tab ``Files''.
\item In the ``Project Filelist'' page, click on ``Administration.''
\item In the ``Releases'' part, click on ``[Edit Releases]''.
\item Click on ``[Edit]'' for the corresponding release.
\item In the part ``Add Files To This Release''.
\begin{verbatim}
File Name:
File type: .jar
Processor type: Any
\end{verbatim}
\item Click on ``Add This File''.
\end{enumerate}
\color{black}
\item Add documents on the web site:
\begin{enumerate}
\item Copy the corresponding documentation (\emph{i.e.} Documentation.pdf to Documentation-v1.04.04.pdf) and add it to the documents of Sourcesup, in the doc folder. For this, go to the tab ``Docs'' and click on ``Add new item'', then:
\begin{verbatim}
Document title: Documentation v1.04.04
Description: Presentation of the FullSWOF_2D software and how to use it
Comment:
Type of Document: File
Upload file:
Folder that document belongs to: doc
Status of the document: active
\end{verbatim}
and click on ``Submit information''.
\item Copy the corresponding documentation for developers (\emph{i.e.} refman.pdf to refman-v1.04.04.pdf) and add it to the documents of Sourcesup, in the doc folder. For this, go to the tab ``Docs'' and click on ``Add new item'', then:
\begin{verbatim}
Document title: Doxygen Documentation v1.04.04
Description: Documentation extracted automatically from the sources
Comment:
Type of Document: File
Upload file:
Folder that document belongs to: doc
Status of the document: active
\end{verbatim}
and click on ``Submit information''.
\end{enumerate}
\item Post news:
\begin{enumerate}
\item Go to the project tab ``News''.
\item Click on ``Submit''.
\item Add a subject, such as:
\begin{verbatim}
Release of FullSWOF_2D 1.04.04
\end{verbatim}
\item Add some details in the panel, such as:\\
\emph{Remark: for \FullSWOFUI, compatibility with \FullSWOFoneD{} and \FullSWOFtwoD{} should be specified.}
\begin{verbatim}
The FullSWOF development team is pleased to announce
the release of FullSWOF_2D 1.04.04.
This is just a minor bug release:
the previous release (1.04.03) did not compile under windows (cygwin).
No other changes.
\end{verbatim}
\item Click on ``Submit''.
\end{enumerate}
\item Send an email to the relevant list (\href{mailto:fullswof.infos@listes.univ-orleans.fr}{fullswof.infos@listes.univ-orleans.fr}
or
\href{mailto:swashes.infos@listes.univ-orleans.fr}{swashes.infos@listes. univ-orleans.fr}), such as:\\
\emph{Remark: for \FullSWOFUI, compatibility with \FullSWOFoneD{} and \FullSWOFtwoD{} should be specified.}
\begin{verbatim}
Title: FullSWOF_2D: release 1.04.04: bug fix (compilation pb)
Dear FullSWOF enthusiasts,
We have just released a new version of FullSWOF_2D (release 1.04.04).
It can be downloaded here:
This is just a minor bug fix: FullSWOF_2D release 1.04.03 did not
compile under windows cygwin (Bug #8814).
If you are using the release 1.04.03 and if it compiled smoothly
under your system, you do not have to worry about it. Just keep working!
Cheers.
The FullSWOF development team
\end{verbatim}
\end{enumerate}
\part{For Windows release}
\setcounter{section}{0}
Releasing \emph{Windows}-specific packages for a new version of \FullSWOFoneD, \FullSWOFtwoD{}, \FullSWOFUI{} or \SWASHES{} requires a succession of operations using various tools.
This part details these steps.
\section{\SWASHES{}}
\subsection{From zip to \_win.zip}
\begin{enumerate}
\item Uncompress the general package of \SWASHES{} (\emph{i.e.} the zip file)
\item In the file ``Makefile'', change the first lines into
\begin{verbatim}
CC=i686-w64-mingw32-g++
SRCDIR=Sources
HEADDIR=Headers
OBJDIR=obj
BINDIR=bin
CFLAGS= -I$(HEADDIR) -Wall -pedantic -O3 -static
EXEC=swashes_win.exe
\end{verbatim}
\item Start cygwin and go to the main directory.
\item Launch ``make''.\\
In bin/, you should now have ``swashes\_win.exe''
\item Uncompress the original zip file and add ``\_win'' to the directory name.
\item Create the \_win.zip file
\begin{verbatim}
zip -r SWASHES-1.01.04_win.zip SWASHES-1.01.04_win
\end{verbatim}
\item Inside this new zip file, add to bin/
\begin{itemize}
\item CommandLinePrompt.lnk
\item swashes\_win.exe
\end{itemize}
\item Add to ./ an updated version of the file README\_win.txt.
\item Create a text file (\emph{e.g.} comment.txt) with some info such as
\begin{verbatim}
SWASHES release 1.01.04 for Windows
(file SWASHES-1.01.04_win.zip)
It is designed to help Windows users to run SWASHES on their exploitation
system. The package contains an executable tested under win 7 64 bits.
For details see file README_win.txt .
Cheers.
The SWASHES development team
\end{verbatim}
\end{enumerate}
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
\section{\FullSWOFoneD{}}
\subsection{From zip to \_win.zip}
\begin{enumerate}
\item Uncompress the general package of \FullSWOFoneD{} (\emph{i.e.} the zip file).
\item In the file ``make\_config'', change the line
\begin{verbatim}
CPP = g++
\end{verbatim}
into
\begin{verbatim}
CPP = i686-w64-mingw32-g++
\end{verbatim}
and add
\begin{verbatim}
-static
\end{verbatim}
at the end of the lines
\begin{verbatim}
CPPFLAGS := -O3
LDFLAGS :=
\end{verbatim}
\item In the file ``Makefile'', change the line
\begin{verbatim}
TARGET := FullSWOF_1D
\end{verbatim}
into
\begin{verbatim}
TARGET := FullSWOF_1D_win.exe
\end{verbatim}
\item Start cygwin and go to the main directory.
\item Launch ``make''.\\
In bin/, you should now have ``FullSWOF\_1D\_win.exe''.
\item Uncompress the original zip file and add ``\_win'' to the directory name.
\item Create the \_win.zip file
\begin{verbatim}
zip -r FullSWOF_1D-1.01.00_win.zip FullSWOF_1D-1.01.00_win
\end{verbatim}
\item Inside this new zip file, add to Examples/
\begin{itemize}
\item CommandLinePrompt.lnk
\item FullSWOF\_1D\_win.exe
\end{itemize}
\item Add to ./ an updated version of the file README\_win.txt.
\item Create a text file (\emph{e.g.} comment.txt) with some info such as
\begin{verbatim}
FullSWOF_1D release 1.01.00 for Windows
(file FullSWOF_1D-1.02.00_win.zip)
It is designed to help Windows users to run FullSWOF_2D on their
exploitation system. The package contains an executable tested
under win 7 64 bits.
It is distributed for EVALUATION PURPOSE ONLY.
For details see file README_win.txt .
Cheers.
The FullSWOF development team
\end{verbatim}
\end{enumerate}
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
\section{\FullSWOFtwoD{}}
\subsection{From zip to \_win.zip}
\begin{enumerate}
\item Uncompress the general package of \FullSWOFtwoD{} (\emph{i.e.} the zip file).
\item In the file ``make\_config'', change the line
\begin{verbatim}
CPP = g++
\end{verbatim}
into
\begin{verbatim}
CPP = i686-w64-mingw32-g++
\end{verbatim}
and add
\begin{verbatim}
-static
\end{verbatim}
at the end of the lines
\begin{verbatim}
CPPFLAGS := -O3
LDFLAGS :=
\end{verbatim}
\item In the file ``Makefile'', change the line
\begin{verbatim}
TARGET := FullSWOF_2D
\end{verbatim}
into
\begin{verbatim}
TARGET := FullSWOF_2D_win.exe
\end{verbatim}
\item Start cygwin and go to the main directory.
\item Launch ``make''.\\
In bin/, you should now have ``FullSWOF\_2D\_win.exe''.
\item Uncompress the original zip file and add ``\_win'' to the directory name.
\item Create the \_win.zip file
\begin{verbatim}
zip -r FullSWOF_2D-1.04.04_win.zip FullSWOF_2D-1.04.04_win
\end{verbatim}
\item Inside this new zip file, add to Examples/
\begin{itemize}
\item CommandLinePrompt.lnk
\item FullSWOF\_2D\_win.exe
\end{itemize}
\item Add to ./ an updated version of the file README\_win.txt.
\item create a text file (\emph{e.g.} comment.txt) with some info such as
\begin{verbatim}
FullSWOF_2D release 1.04.04 for Windows
(file FullSWOF_2D-1.04.04_win.zip)
It is designed to help Windows users to run FullSWOF_2D on their
exploitation system. The package contains an executable tested
under win 7 64 bits.
It is distributed for EVALUATION PURPOSE ONLY.
For details see file README_win.txt .
Cheers.
The FullSWOF development team
\end{verbatim}
\end{enumerate}
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
\section{\FullSWOFUI{}}
\subsection{From .jar to \_win.zip}
\begin{enumerate}
\item Create a directory named FullSWOF\_UI-2.00.00\_win .
\item Copy the jar file of \FullSWOFUI{} into it.
\item Unpack the FullSWOF\_1D\_win.zip and FullSWOF\_2D\_win.zip files into it.
\item In the FullSWOF\_1D\_win and FullSWOF\_2D\_win directories, delete the make\_config and Makefile files, and all the sub-directories except Examples/ .
\item Add to ./ the files
FullSWOF\_UI-2.00.00/util/User\_Manual\_en.pdf and
FullSWOF\_UI-2.00.00/util/User\_Manual\_fr.pdf.
\item Add to ./ the two license files FullSWOF\_UI-2.00.00/LICENSE\_en.txt and
FullSWOF\_UI-2.00.00/LICENSE\_fr.txt.
\item Add to ./ an updated version of the file README\_win.txt.
\item Create the zip file
\begin{verbatim}
zip -r FullSWOF_UI-2.00.00_win.zip FullSWOF_UI-2.00.00_win
\end{verbatim}
\item Create a text file (\emph{e.g.} comment.txt) with some info such as
\begin{verbatim}
FullSWOF_UI release 2.00.00 for Windows
(file FullSWOF_UI-2.00.00_win.zip)
It is designed to help Windows users to run FullSWOF on their
exploitation system. It contains the FullSWOF_UI jar file, and the FullSWOF_1D
and FullSWOF_2D exe files tested under win 7 64 bits.
It is distributed for EVALUATION PURPOSE ONLY.
For details see file README_win.txt .
Cheers.
The FullSWOF development team
\end{verbatim}
\end{enumerate}
% % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % % %
\end{document}