From b0ab7c260f5e7723f17580eefd632e531c050fa6 Mon Sep 17 00:00:00 2001
From: Andre Maroneze <andre.maroneze@cea.fr>
Date: Mon, 18 Oct 2021 17:11:02 +0200
Subject: [PATCH] [Dev] add release target and update instructions
---
devel_tools/docker/Makefile | 24 ++++++++++++++++++
doc/release/website.tex | 49 +++++++++++++++++++------------------
2 files changed, 49 insertions(+), 24 deletions(-)
diff --git a/devel_tools/docker/Makefile b/devel_tools/docker/Makefile
index 550e9d75a98..0c29e493140 100644
--- a/devel_tools/docker/Makefile
+++ b/devel_tools/docker/Makefile
@@ -54,6 +54,30 @@ dev-stripped: Dockerfile.dev
docker build . -t framac/frama-c:dev-stripped --target frama-c-stripped -f $^ $(ARGS)
TARGETS += dev-stripped
+release: Dockerfile.dev Dockerfile.template
+ @export archive="frama-c-$$(cat ../../VERSION)-$$(cat ../../VERSION_CODENAME).tar.gz"; \
+ if [ ! -e "$$archive" ]; then \
+ echo "error: $$archive not found; run 'make src-distrib' and put the .tar.gz in this directory."; \
+ exit 1; \
+ fi; \
+ docker build . -t framac/frama-c:release --target frama-c-slim --build-arg=from_archive="$$archive" -f $<
+ @echo "Now run: 'docker tag framac/frama-c:release framac/frama-c:<version>'"
+TARGETS += release
+
+release-gui: Dockerfile.dev
+ @echo "For 'dev' builds, consider adding ARGS=--no-cache to force"
+ @echo "Docker to rebuild all layers."
+ docker build . -t framac/frama-c-gui:release --target frama-c-gui-slim -f $^ $(ARGS)
+ @echo "Now run: 'docker tag framac/frama-c-gui:release framac/frama-c-gui:<version>'"
+TARGETS += release-gui
+
+release-stripped: Dockerfile.dev
+ @echo "For 'dev' builds, consider adding ARGS=--no-cache to force"
+ @echo "Docker to rebuild all layers."
+ docker build . -t framac/frama-c:release-stripped --target frama-c-stripped -f $^ $(ARGS)
+ @echo "Now run: 'docker tag framac/frama-c:release-stripped framac/frama-c:<version>-stripped'"
+TARGETS += release-stripped
+
# Note: alpine-3.14 has Z3 version 4.8.11, which is not supported in some
# versions of Why3, so we remain with alpine-3.13 for now.
Dockerfile.dev: Makefile Dockerfile.template env.template
diff --git a/doc/release/website.tex b/doc/release/website.tex
index 07703879f00..075c481f781 100644
--- a/doc/release/website.tex
+++ b/doc/release/website.tex
@@ -195,43 +195,44 @@ Just update the \texttt{VERSION} file in \texttt{master}, by adding
\textbf{Note:} you need access to the \texttt{framac} Docker Hub account to be able to upload the image.
-Make sure:
+Make sure that \texttt{devel\_tools/docker/Makefile} is up-to-date:
+
\begin{itemize}
- \item \texttt{devel\_tools/docker/frama-c.dev/Dockerfile}
- \item \texttt{devel\_tools/docker/frama-c.custom/Dockerfile}
+\item changes to \texttt{reference-configuration.md} must have been ported
+ to the corresponding \texttt{Dockerfile.dev} entry inside the
+ \texttt{Makefile}.
\end{itemize}
-are up-to-date; to do so, you can do the following:
-\begin{lstlisting}
-cd devel_tools/docker/frama-c.custom
-<edit Dockerfile to change the base image, from debian:sid (unstable) to the
- latest stable release>
-<copy release .tar.gz to this directory, extract and rename the directory
- `frama-c`>
-docker build . -t fc-with-test --build-arg=with_source=yes\
- --build-arg=with_test=yes
-\end{lstlisting}
+Copy the \texttt{.tar.gz} archive to the \texttt{devel\_tools/docker} directory.
-This should copy the contents of \texttt{frama-c} into the Docker image and try
-to compile Frama-C with it, then run the tests.
+Run \texttt{make release}. It should decompress the archive, build and test
+the Frama-C Docker image.
If the local tests do not work, check that the OCaml version and package
-dependencies are all up-to-date. Remember that there are several differences
-between Debian unstable (`sid`) and stable, which may require changes to the
-\texttt{Dockerfile}.
+dependencies are all up-to-date.
+
+If the image is built succesfully, you can also try building the GUI image
+(\texttt{make release-gui}) and the stripped image
+(\texttt{make release-stripped}).
-If the local tests work, then re-run Docker \textit{without} the source/tests,
-to make the image leaner:
+If you want to upload these images to the Docker Hub, you can re-tag them, e.g.
\begin{lstlisting}
-docker build . -t framac/frama-c:<VERSION>
+docker tag framac/frama-c:release framac/frama-c:<VERSION>
\end{lstlisting}
-Replacing \texttt{<VERSION>} with the release number, e.g. \texttt{23.0}.
+Where \texttt{<VERSION>} is the release number, possibly with a suffix, but
+{\em without} characters such as \texttt{+}. For instance, you can use
+\texttt{23.1-beta} for a beta release.
-After building the image, upload it with \texttt{docker push framac/frama-c:<VERSION>}.
-You will need to have setup your \texttt{framac} Docker Hub account for this to work.
+Then upload the renamed image(s) with:
+\begin{lstlisting}
+docker push framac/frama-c:<VERSION>
+docker push framac/frama-c-gui:<VERSION>
+docker push framac/frama-c:<VERSION>-stripped
+\end{lstlisting}
+You will need to have setup your \texttt{framac} Docker Hub account for this to work.
%%% Local Variables:
%%% mode: latex
--
GitLab