... | ... | @@ -30,17 +30,17 @@ with the following main branches: |
|
|
|-------------|---------------|
|
|
|
| `master` | Bugfix updates since the last release, should always be stable and runnable (suitable for production) |
|
|
|
| `develop` | Current developments, slated for the next release. The code in develop is generally quite stable, but minor regressions may occasionally occur. |
|
|
|
| `maintenance-v1906` ... | Bugfix branches for previous releases, should always be stable and runnable (suitable for production) |
|
|
|
| `maintenance-v1912` ... | Bugfix branches for previous releases, should always be stable and runnable (suitable for production) |
|
|
|
| `feature-XYZ` | Work-in-progress feature branch (primarily internal use, no guarantees) |
|
|
|
|
|
|
Most people will use the `master` branch to have up-to-date bugfixes
|
|
|
of the current release. When a new code version is released, `master`
|
|
|
is renamed `maintenance-{prevRelease}` and a new `master` is created at release.
|
|
|
|
|
|
The _feature_ branches (as denoted by their prefix), have no
|
|
|
The `feature` branches (as denoted by their prefix), have no
|
|
|
guarantee of being stable and are liable to change at any time.
|
|
|
Since they will also occasionally be rebased onto the lastest
|
|
|
_develop_, there is ***no*** guarantee of continuity.
|
|
|
`develop`, there is ***no*** guarantee of continuity.
|
|
|
|
|
|
|
|
|
### Exploring projects
|
... | ... | @@ -48,7 +48,7 @@ _develop_, there is ***no*** guarantee of continuity. |
|
|
- From the projects menu you can navigate through various projects as shown below.
|
|
|
![GitLab All projects](/images/KB-GL-ADV-project-list.png)
|
|
|
|
|
|
- Selecting a project, e.g. OpenFOAM, ThirdParty, provides further details. Each project has a similar structure; the main OpenFOAM repository is shown below.
|
|
|
- Selecting a project, e.g. `openfoam` or `ThirdParty-common`, provides further details. Each project has a similar structure; the main OpenFOAM repository is shown below.
|
|
|
![GitLab OpenFOAM project](/images/KB-GL-ADV-openfoam-project.png)
|
|
|
|
|
|
- Options for managing notifications, marking favourites (starred projects), or accessing git clone features are located on the right side of webpage as shown below. See the [Cloning section](#openfoam-repositories_terminal-mode-cloning) for more information.
|
... | ... | @@ -57,7 +57,7 @@ _develop_, there is ***no*** guarantee of continuity. |
|
|
- If you are looking for a one-off download for any particular branch (with no git history), browse to the required branch and select from the download options:
|
|
|
![GitLab download options](/images/KB-GL-ADV-project-download.png)
|
|
|
|
|
|
- Alternatively, browse a repository for files, branches, tags, etc. via the Repository section:
|
|
|
- Alternatively, browse a repository for files, branches, tags, etc. via the _Repository_ section:
|
|
|
![GitLab repository view](/images/KB-GL-ADV-openfoam-repo-view.png)
|
|
|
|
|
|
|
... | ... | @@ -65,29 +65,29 @@ _develop_, there is ***no*** guarantee of continuity. |
|
|
|
|
|
#### Get a snapshot
|
|
|
|
|
|
- Cloning allows you to synchronize your local code with the latest developments. The address for cloning is available on the right hand side of "Project->Details" slider of the repository:
|
|
|
- Cloning allows you to synchronize your local code with the latest developments. The address for cloning is available on the right hand side of _Project overview -> Details_ slider of the repository:
|
|
|
|
|
|
![GitLab clone address](/images/KB-GL-ADV-project-clone-address.png)
|
|
|
|
|
|
- Clone the default _master_ branch via HTTPS using
|
|
|
- Clone the default `master` branch via HTTPS using
|
|
|
```
|
|
|
git clone https://develop.openfoam.com/Development/openfoam.git
|
|
|
```
|
|
|
|
|
|
- **Optional:** You may specify a target branch directly using
|
|
|
```
|
|
|
git clone -b <branch name> <address of git> <name of resulting directory>
|
|
|
git clone -b <local branch name> <git url> <name of resulting directory>
|
|
|
```
|
|
|
e.g. to clone the _develop_ branch to your local `OpenFOAM-com` directory via HTTPS:
|
|
|
e.g. to clone the `develop` branch to your local `OpenFOAM-com` directory via HTTPS:
|
|
|
```
|
|
|
git clone -b develop https://develop.openfoam.com/Development/openfoam.git OpenFOAM-com
|
|
|
```
|
|
|
|
|
|
- Since [OpenFOAM-v1712](https://www.openfoam.com/releases/openfoam-v1712) community contributions may be included using the git submodule system. To initialise the submodules located in the [$WM_PROJECT_DIR/modules](https://develop.openfoam.com/Development/openfoam/tree/master/modules) directory:
|
|
|
- Since [OpenFOAM-v1712](https://www.openfoam.com/releases/openfoam-v1712), community contributions may be included using the [git submodule system](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To initialise the submodules located in the [$WM_PROJECT_DIR/modules](https://develop.openfoam.com/Development/openfoam/tree/master/modules) directory:
|
|
|
```
|
|
|
git submodule init
|
|
|
```
|
|
|
The respective [Modules Readme](https://develop.openfoam.com/Development/openfoam/blob/develop/modules/README.md)
|
|
|
The respective [modules/README](https://develop.openfoam.com/Development/openfoam/blob/develop/modules/README.md)
|
|
|
contains more information.
|
|
|
|
|
|
|
... | ... | @@ -97,13 +97,12 @@ git submodule init |
|
|
entire history. This makes for a smaller repository and faster cloning.
|
|
|
```
|
|
|
git clone --depth=1 https://develop.openfoam.com/Development/openfoam.git
|
|
|
|
|
|
cd openfoam
|
|
|
git submodule init && git submodule update --depth=1
|
|
|
```
|
|
|
|
|
|
If you want more than just the very last commit, adjust the clone
|
|
|
depth accordingly. For example,
|
|
|
depth accordingly. For example, to obtain the repository with the last 8 commits:
|
|
|
```
|
|
|
git clone --depth=8 https://develop.openfoam.com/Development/openfoam.git
|
|
|
```
|
... | ... | @@ -121,7 +120,7 @@ git submodule update |
|
|
```
|
|
|
- Note: if you experience merge conflicts during the pull due to your own local code changes, you will need to resolve them manually/reset the state of your repository and re-pull
|
|
|
|
|
|
Quite often it can be useful to monitor changes without actually
|
|
|
Quite often, it can be useful to monitor changes without actually
|
|
|
updating your local files:
|
|
|
```
|
|
|
git fetch
|
... | ... | @@ -139,12 +138,16 @@ git fetch |
|
|
|
|
|
#### Adding a SSH key
|
|
|
|
|
|
If you use SSH for cloning, you can access your profile related
|
|
|
settings from the top-right of the browser page. Follow the steps
|
|
|
If you use SSH for cloning, you can access the related settings of
|
|
|
your profile from the top-right of the browser page. Follow the steps
|
|
|
numbered in the snapshot to add a key to your profile. You may add
|
|
|
multiple SSH keys and distinguish them with proper title.
|
|
|
|
|
|
![GitLab Add SSH key](/images/KB-GL-ADV-add-ssh-key.png)
|
|
|
![GitLab Add SSH key](/images/KB-GL-ADV-add-ssh-key.png)
|
|
|
|
|
|
----
|
|
|
|
|
|
Copyright (C) 2019-2020 OpenCFD Ltd.
|
|
|
|
|
|
|
|
|
[foam-repo]: https://develop.openfoam.com/Development/openfoam/
|
... | ... | |