Open main menu

DAVE Developer's Wiki β

Changes

MISC-TN-028: GitLab-based workflow

3 bytes removed, 06:31, 18 August 2023
Essential steps of the workflow
==Essential steps of the workflow==
This section describes in detail the essential steps the workflow is composed of. To this end, we will use a very simple example based on a an ad hoc repository, named <code>test0</code>. The goal is to write the first release of the code by following the recommended workflow.
Once the repository is created on GitLab, we create an issue. Every implementation should start with this step: '''first of all, create an issue'''!
</pre>
Then, we checkout check out the branch named <code>1-first-release</code>:
<pre class="workstation-terminal">
$ cd test0/
[[File:Gitlab-wf-4.png|center|thumb]]
On GitLab-side we can close the merge request. We mark it as ready in order to prepare it for merging:[[File:Gitlab-wf-5.png|center|thumb]]In case you have the permission to start the merging by yourself, you can press the "Merge" button. If you do not have such permission, for example because you have been assigned a <code>developer</code> role, this operation will be run by the <code>maintainer</code> of the repository on your behalf, possibily possibly after reviewing your code.[[File:Gitlab-wf-6.png|center|thumb]]After merging is complete, you should see something like this:[[File:Gitlab-wf-7.png|center|thumb]]If we check the <code>master</code> branch, GitLab confirms that the merging was completed successfully:[[File:Gitlab-wf-8.png|center|thumb]]We can also see a graphical representation of we just did: it is clear that the that temporary branch was deleted after it had been merged into the <code>master</code> branch: [[File:Gitlab-wf-9.png|center|thumb]]
== Conclusion ==
We strongly recommend to use this workflow for any implementation, being it adding a new feature, fixing a bug, optimizing a function, or whatever. Even though it may seem a little bit cumbersome at first sight, it has proved to be very efficient and effective when several developers are involved in the same project.
4,650
edits