Recent changes to SCM Repositories

SCM Repositories modified by Ingo

Ingo — Sat, 22 Sep 2018 08:11:47 -0000

--- v4
+++ v5
@@ -52,6 +52,13 @@

 CODESYS SVN is usually a comercial add on for professionals. But it can be used for free to access repositories from CODESYS Forge. You can get it from the [CODESYS Store](https://store.codesys.com/codesys-svn.html).

+## Project version
+CODESYS is always backward compatible. So you can use an older library or project always with a newer version of CODESYS. So usually you should not encounter any compatibility problems between you and your users, as they can always use the most current version of CODESYS.
+
+But converting the projects and libraries forth and back all the time is no good idea. So when you are working with a small team on a project, you should decide to use one specific project format within the team.
+
+The contineous integration system on CODESYS Forge is obviously also based on a specific version. So check the [documentation](Continous Integration) if you work with that.
+
 # Git

 Git works in many respects very similar to SVN. In the following we will point out the conceptional differences when working in a Team.

SCM Repositories modified by Ingo

Ingo — Sat, 22 Sep 2018 08:03:43 -0000

--- v3
+++ v4
@@ -33,31 +33,19 @@

 A CODESYS project, which is imported into SVN or checked out from SVN has a connection to this repository, very similar to a folder which you checked out with one of the other SVN clients.

-You should avoid to work in the same repository with different clients. So you should not use the an SVN client like Tortoise SVN and CODESYS SVN on the same repository. The reason is, that the risk of committing specific files with the wrong tool is too high.
+You should avoid to work in the same repository with different clients. So you should not use an SVN client like Tortoise SVN and CODESYS SVN on the same repository. The reason is, that the risk of committing specific files with the wrong tool is too high.

-So, don't commit your libraries like this:
+To reduce this risk, you can use the tool [cforge](/tol/cforge) to checkout and update the repository on your PC, as cforge will not checkout internal files of CODESYS SVN.
+
+This is the layout, how cforge would commit the data, but which you should avoid when you maintain the repository without cforge:

 ~~~
 MyHeatingControl.project
 pumps.library
-sensors.libtary
+sensors.library
 MyHeatingControl/...
 pumps/...
 sensors/...
-~~~
-
-... but only commit it with CODESYS SVN:
-~~~
-MyHeatingControl/...
-pumps/...
-sensors/...
-~~~
-
-The CODESYS libraries are then only checked out on your PC:
-~~~
-MyHeatingControl.project
-pumps.library
-sensors.libtary
 ~~~

 It is recommended to use a separated repository for CODESYS projects. Separating the code which is maintained with different SVN clients makes the handling of branches and tags easier.

SCM Repositories modified by Ingo

Ingo — Wed, 25 Apr 2018 20:16:24 -0000

--- v2
+++ v3
@@ -62,7 +62,7 @@

 It is recommended to use a separated repository for CODESYS projects. Separating the code which is maintained with different SVN clients makes the handling of branches and tags easier.

-CODESYS SVN is usually a comercial add on for professionals. But there is a free package, called [CODESYS SVN Forge](https://store.codesys.com/codesys-svn-forge.html), whcih you can use for free, if you connect only on CODESYS Forge.
+CODESYS SVN is usually a comercial add on for professionals. But it can be used for free to access repositories from CODESYS Forge. You can get it from the [CODESYS Store](https://store.codesys.com/codesys-svn.html).

 # Git

SCM Repositories modified by codesys.com

codesys.com — Mon, 08 Jan 2018 16:50:09 -0000

--- v1
+++ v2
@@ -33,9 +33,9 @@

 A CODESYS project, which is imported into SVN or checked out from SVN has a connection to this repository, very similar to a folder which you checked out with one of the other SVN clients.

-For convenience, we recommend to check this binary project or library, containing this connection to SVN, additionally in. This way, you can maintain the CODESYS in its binary form, as well as the SVN sources in one repository.
+You should avoid to work in the same repository with different clients. So you should not use the an SVN client like Tortoise SVN and CODESYS SVN on the same repository. The reason is, that the risk of committing specific files with the wrong tool is too high.

-Here is a possible repository layout:
+So, don't commit your libraries like this:

 ~~~
 MyHeatingControl.project
@@ -46,9 +46,23 @@
 sensors/...
 ~~~

-It is recommended to use a separated repository for CODESYS projects. As you use with CODESYS SVN another SVN client for it as you use for your other code, it makes the handling of branches and tags easier.
+... but only commit it with CODESYS SVN:
+~~~
+MyHeatingControl/...
+pumps/...
+sensors/...
+~~~

-CODESYS SVN is usually a comercial add on for professionals. But there is community edition which can be freely used with CODESYS Forge.
+The CODESYS libraries are then only checked out on your PC:
+~~~
+MyHeatingControl.project
+pumps.library
+sensors.libtary
+~~~
+
+It is recommended to use a separated repository for CODESYS projects. Separating the code which is maintained with different SVN clients makes the handling of branches and tags easier.
+
+CODESYS SVN is usually a comercial add on for professionals. But there is a free package, called [CODESYS SVN Forge](https://store.codesys.com/codesys-svn-forge.html), whcih you can use for free, if you connect only on CODESYS Forge.

 # Git

SCM Repositories modified by codesys.com

codesys.com — Thu, 04 Jan 2018 14:51:48 -0000

Subversion (SVN)
- Trunk
- Tags
- Branches
- CODESYS
Git
- Master
- Fork
- Tags
CODESYS Libraries
Merge Requests (aka Pull Requests)

General
HowTos

For your project, you can choose between two different source code management systems. As CODESYS provides native support for SVN, we would always recommend that if you want to manage CODESYS projects.
In every other cases, git has the huge advantage, that you can work locally, make even local commits, and push everything to the master repository only after you are satisfied with the result.
Especially in distributed, open source projects, where all participants have their own goals, this is a huge advantage.

Subversion (SVN)

We recommend the use of the following tools:

• SVN commandline tools
• TortoiseSVN
• CODESYS SVN

In general you can work with the following workflow:

Trunk

Use the folder "trunk" to write and commit all your code

Branches

In Distributet Projects it is a good idea if not everyone is committing to the same trunk when they are developing larger features. It is recommended to create a "ticket" to describe the development and create a branch to develop this feature.
After finish and review by other project members, one can then "merge" this change into the trunk.

CODESYS

CODESYS projects are usually saved in a propritary binary format. CODESYS SVN is an add on for CODESYS, which breaks this format out into several objects, which are then maintained in SVN. CODESYS itself is acting as the SVN client and the merge tool in this scenario.

A CODESYS project, which is imported into SVN or checked out from SVN has a connection to this repository, very similar to a folder which you checked out with one of the other SVN clients.

For convenience, we recommend to check this binary project or library, containing this connection to SVN, additionally in. This way, you can maintain the CODESYS in its binary form, as well as the SVN sources in one repository.

Here is a possible repository layout:

MyHeatingControl.project
pumps.library
sensors.libtary
MyHeatingControl/...
pumps/...
sensors/...

It is recommended to use a separated repository for CODESYS projects. As you use with CODESYS SVN another SVN client for it as you use for your other code, it makes the handling of branches and tags easier.

CODESYS SVN is usually a comercial add on for professionals. But there is community edition which can be freely used with CODESYS Forge.

Git

Git works in many respects very similar to SVN. In the following we will point out the conceptional differences when working in a Team.

We recommend the use of the following tools:

• Git command line
• Tortoise Git

Note, CODESYS doesn't support Git at the moment. See the chapter below for more details.

Master

This is the version of the repository where everyone is working on. It can be compared to the "trunk" in SVN.

Fork

Every larger change should be done in a fork, which can be compared to SVN "branches". A fork can later be merged to the master.

CODESYS Libraries

CODESYS supports to store projects or libraries in SVN. As you need CODESYS to resolve conflicts it is always a good idea to use an own Repository for CODESYS libraries or projects.

Merge Requests (aka Pull Requests)

In Git you can place so called "Merge Requests", which are very similar to "Pull Requests" on GitHub.

You are free to use those on CODESYS Forge for your project. But, as we propose a multi-repository project layout in combination with SVN for CODESYS projects, we don't suggest it.

To track branches, which need to be integrated, we recommend the use of Tickets.

Recent changes to SCM Repositories

SCM Repositories modified by Ingo

SCM Repositories modified by Ingo

SCM Repositories modified by Ingo

SCM Repositories modified by codesys.com

SCM Repositories modified by codesys.com

Subversion (SVN)

Trunk

Tags

Branches

CODESYS

Git

Master

Fork

Tags

CODESYS Libraries

Merge Requests (aka Pull Requests)