From f625c8394ba4ab89d870a54f7521f1673b86d75d Mon Sep 17 00:00:00 2001 From: VictoriaDel Date: Mon, 14 Jun 2021 14:36:53 +0200 Subject: [PATCH] Updated jolt version (v1.0.4) and updated documentation on how to make a new release in github --- doc/developer-doc.tex | 12 ++++++++---- src/jolt/__init__.py | 2 +- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/developer-doc.tex b/doc/developer-doc.tex index 1755d6f..355e478 100644 --- a/doc/developer-doc.tex +++ b/doc/developer-doc.tex @@ -68,15 +68,19 @@ \subsection{Building the firmware} \section{Distribution} -\subsection{Marking a new version} +\subsection{Marking a new version & release} + +Bug fixes, new features, GUI improvement should always be accompanied by a new release of JOLT software. It's crucial to update both github and bitbucket with the latest merged changes. +In github it's possible to mark the last commit as a new release. \begin{enumerate} \item Edit \texttt{src/jolt/\_\_init\_\_.py}, and set \texttt{\_\_version\_\_} to the new version number, eg "1.0.3". Commit this change. - \item Tag the commit with a corresponding name, but starting with a "v", eg "v1.0.3". + \item Tag the commit by using the "git tag" command with the tag name (starting with a "v", eg "v1.0.3") and the commit SHA. In the tag text, put the changelog. - \item You can now build the release files. - \item After the build, you can update again the \texttt{\_\_version\_\_} to a development version, + \item You can now build the release files and update again the \texttt{\_\_version\_\_} to a development version, eg, "1.0.3-dev". + \item Go to \texttt{https://github.com/delmic/jolt-control/releases} and click on \texttt{Draft a new release} button. + Define the release version, write a short description about the new additions and attach the signed jolt and firmware updater executable files. \end{enumerate} diff --git a/src/jolt/__init__.py b/src/jolt/__init__.py index cd3ad33..5900f37 100644 --- a/src/jolt/__init__.py +++ b/src/jolt/__init__.py @@ -17,7 +17,7 @@ along with this program; if not, see http://www.gnu.org/licenses/. ''' -__version__ = "1.0.3" +__version__ = "1.0.4" __fullname__ = "Delmic Jolt Control Software" __shortname__ = "Jolt" __copyright__ = "Copyright © 2019-2021 Delmic"