Skip to content

Commit

Permalink
Updated jolt version (v1.0.4) and updated documentation on how to mak…
Browse files Browse the repository at this point in the history
…e a new release in github
  • Loading branch information
VictoriaDel committed Jun 14, 2021
1 parent 2d7ba07 commit f625c83
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions doc/developer-doc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -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}


Expand Down
2 changes: 1 addition & 1 deletion src/jolt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit f625c83

Please sign in to comment.