Skip to content
Snippets Groups Projects
Commit cdf6ec13 authored by Allan Blanchard's avatar Allan Blanchard
Browse files

[release/doc] a few details in the manual

parent 0615acc7
No related branches found
No related tags found
No related merge requests found
...@@ -68,21 +68,32 @@ one. ...@@ -68,21 +68,32 @@ one.
\section{Version} \section{Version}
Execute the script: On the new \texttt{stable} branch, execute the script:
\begin{verbatim} \begin{verbatim}
./dev/set-version.sh NN.M # to be replaced with actual major/minor version ./dev/set-version.sh NN.M # to be replaced with actual major/minor version
\end{verbatim} \end{verbatim}
This will: This will:
\begin{itemize} \begin{itemize}
\item update the \texttt{Changelog}s \item update the \texttt{Changelog}s
\item update the changes in the manuals (excluding ACSL and E-ACSL references) \item update the changes in the manuals \textbf{(excluding ACSL and E-ACSL references)}
\item update the \texttt{VERSION} and \texttt{VERSION\_CODENAME} files \item update the \texttt{VERSION} and \texttt{VERSION\_CODENAME} files
\item update the \texttt{opam} file \item update the \texttt{opam} files (Frama-C, lint, hdrck)
\item update the API doc \item update the API doc
\end{itemize} \end{itemize}
Merge the branch in \texttt{master} and add a commit to \texttt{master} by Merge the \texttt{stable} branch in the \texttt{master} branch.
adding \texttt{"+dev"} in the \texttt{VERSION} file.
On the \texttt{master} branch, execute the script:
\begin{verbatim}
./dev/set-version.sh dev
\end{verbatim}
This will:
\begin{itemize}
\item update the \texttt{VERSION} file
\item update the \texttt{opam} files (Frama-C, lint, hdrck)
\end{itemize}
Commit this change and push.
\section{Copyright} \section{Copyright}
......
...@@ -37,7 +37,6 @@ Change version and codename in the following files: ...@@ -37,7 +37,6 @@ Change version and codename in the following files:
\begin{itemize} \begin{itemize}
\item \texttt{ALL\_VERSIONS} (non-beta only) \item \texttt{ALL\_VERSIONS} (non-beta only)
\item \texttt{VERSION} (for beta releases, add suffix \texttt{\textasciitilde{}beta}, not \texttt{-beta}) \item \texttt{VERSION} (for beta releases, add suffix \texttt{\textasciitilde{}beta}, not \texttt{-beta})
\item \texttt{VERSION\_CODENAME}
\item \texttt{opam} \item \texttt{opam}
\begin{itemize} \begin{itemize}
\item change version (for beta releases, add suffix \texttt{\textasciitilde{}beta}, not \texttt{-beta}) \item change version (for beta releases, add suffix \texttt{\textasciitilde{}beta}, not \texttt{-beta})
...@@ -187,6 +186,10 @@ of the website and the wiki page. ...@@ -187,6 +186,10 @@ of the website and the wiki page.
Create the version commit, tag it using \texttt{git tag \$(cat VERSION | sed -e "s/\textasciitilde /-/")} Create the version commit, tag it using \texttt{git tag \$(cat VERSION | sed -e "s/\textasciitilde /-/")}
and push it (e.g. via \texttt{git push origin \$(cat VERSION | sed -e "s/\textasciitilde/-/")}). and push it (e.g. via \texttt{git push origin \$(cat VERSION | sed -e "s/\textasciitilde/-/")}).
\textbf{
If the tagged commit itself has not been pushed, remember to push it, else,
the release pipeline will fail.
}
%%%Local Variables: %%%Local Variables:
%%%TeX-master: "release" %%%TeX-master: "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