Difference between revisions of "TDE Gitea Workspace"

From Trinity Desktop Project Wiki

Revision as of 08:43, 19 August 2018

About Gitea

Gitea is, as described on their official website, a "painless self-hosted Git service".

It provides a free, self-hosted and easy way to maintain and share GIT repositories and facilitate collaboration among several contributors, providing a workflow similar to that offerred by other websites such as GitHub, GitLab and many others.

TDE Gitea Workspace

The official TDE source code is stored on the main Trinity Desktop servers and is available both through Git or web interface. External mirrors also provide access to the source code.
None of these methods allows users to easily propose software changes or bug fixes, having to email patches to one of the TDE core developers or uploading code to the TDE bugszilla in order to do that.

The TDE Gitea Workspace (TGW) is a copy of the official source code repositories that is synchronized with the main server on a hourly basis. It offers wider bandwidth and a collaboration workflow that helps achieving the aim of providing:

fast access to the source code, both through Git or web interface
an easy tool for users and external developers to propose code changes and improvements
a quick way for code sharing and collaboration amongst developers
a simple workflow for reviewing, testing and merging code patches

TGW serves the needs of the following groups:

people who want to have fast read-only access to the TDE source code
users who intend to contribute a few patches here and there on a non regular basis
contributors who intend to submit code changes on a regular basis with the aim of becoming long term TDE developers
developers who want to cooperate on some common functionality or bug fix

Using the TDE Gitea Workspace

As a generic user

You can access TGW in read only mode as an unregistered user. This allows you to clone the TDE source code and keep up to date with the latest commits on a regular basis.
Follow the instructions below to clone the complete set of repositories or just a specific module.

Cloning the complete TDE code

Create a base folder for the TDE source code. Then:

 # Main TDE repository
 cd "<TDE folder>"
 git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde
 cd tde
 git submodule init -- scripts
 git submodule update -- scripts
 ./scripts/switch_all_submodules_to_head_and_clean anonymous
 
 # TDE packaging repository
 cd "<TDE folder>"
 git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde-packaging

To keep your local copy up to date, run the following commands on a regular basis.

 # Main TDE repository
 cd "$TDE_DIR"
 ./scripts/switch_all_submodules_to_head_and_clean anonymous
 
 # TDE packaging repository
 cd "$TDE_DIR" && git pull --rebase

Cloning a specific TDE module

NOTE: some of the modules may not have the admin or cmake submodules, so you may need to adjust the procedure below accordingly.

First find out the required module cloning address by accessing the module on the TDE Gitea Workspace. An https cloning link is provided on the main page of each repository.

Then:

 git clone <module cloning address>
 cd "<module folder>"
 git submodule init
 git submodule update

If you wish, you can clone TDE packaging repository as follow (make sure NOT to be in the <module folder> before you go ahead).

 git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde-packaging

To keep your local copy up to date, run the following commands on a regular basis.

 cd "<module folder>" && git pull --rebase && git submodule update

If you have also cloned the packaging folder:

 cd "<tde-packaging folder>" && git pull --rebase

As a contributor

TODO

As a TDE developer

TODO

Retrieved from "https://wiki.trinitydesktop.org/index.php?title=TDE_Gitea_Workspace&oldid=682"

Category:

Developers

@@ Line 37: / Line 37: @@
 ===Cloning the complete TDE code===
-* Create a base folder for the TDE source code, hereafter referred to as TDE_DIR. Then:
+* Create a base folder for the TDE source code. Then:
   # Main TDE repository
-  cd "$TDE_DIR"
+  cd "<TDE folder>"
   git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde
   cd tde
@@ Line 48: / Line 48: @@
   # TDE packaging repository
-  cd "$TDE_DIR"
+  cd "<TDE folder>"
   git clone https://mirror.git.trinitydesktop.org/gitea/TDE/tde-packaging
@@ Line 64: / Line 64: @@
 '''NOTE''': some of the modules may not have the '''admin''' or '''cmake''' submodules, so you may need to adjust the procedure below accordingly.
-* First find out the required module cloning address by accessing the module on the [https://mirror.git.trinitydesktop.org/gitea TDE Gitea Workspace]. An https cloning link is provided on the main page of each repository. Then:
+* First find out the required module cloning address by accessing the module on the [https://mirror.git.trinitydesktop.org/gitea TDE Gitea Workspace]. An https cloning link is provided on the main page of each repository.<br>
+[[File:Gitea_module_cloning_address.jpeg|800px|Module cloning address example]]<br>
+Then:
   git clone <module cloning address>
   cd "<module folder>"
-  git submodule init -- admin cmake
+  git submodule init
-  git submodule update -- admin cmake
+  git submodule update
-  cd "<module folder>/admin" && git checkout master
-  cd "<module folder>/cmake" && git checkout master
 If you wish, you can clone TDE packaging repository as follow (make sure '''NOT''' to be in the <module folder> before you go ahead).
@@ Line 79: / Line 80: @@
 * To keep your local copy up to date, run the following commands on a regular basis.
-  cd "<module folder>"       && git pull --rebase
+  cd "<module folder>" && git pull --rebase && git submodule update
-  cd "<module folder>/admin" && git pull --rebase
-  cd "<module folder>/cmake" && git pull --rebase
 If you have also cloned the packaging folder: