|
|
<!-- --- title: Accessing the code -->
|
|
|
|
|
|
[![home](/icons/home.svg "wiki home")](/home)
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
## OpenFOAM repositories
|
... | ... | @@ -11,8 +13,8 @@ features (such as reporting issues), users must create an account. |
|
|
|
|
|
| Repository | Issue tracker |
|
|
|
|------------|---------------|
|
|
|
| [OpenFOAM](https://develop.openfoam.com/Development/openfoam/) | [issues](https://develop.openfoam.com/Development/openfoam/issues) |
|
|
|
| [ThirdParty](https://develop.openfoam.com/Development/ThirdParty-common/) build scripts | [issues](https://develop.openfoam.com/Development/ThirdParty-common/issues) |
|
|
|
| [OpenFOAM][foam-repo] | [issues][foam-issues] |
|
|
|
| [ThirdParty][third-repo] build scripts | [issues][third-issues] |
|
|
|
|
|
|
_If you have been using the [older OpenFOAM git repository][old-foam-repo] (prior to DEC-2019)
|
|
|
and have code you need to migrate, you should see the [repository migration](Repository-migration) information._
|
... | ... | @@ -20,11 +22,11 @@ and have code you need to migrate, you should see the [repository migration](Rep |
|
|
|
|
|
### Organization of git branches
|
|
|
|
|
|
The OpenFOAM repository follows a
|
|
|
OpenFOAM follows a
|
|
|
[branching workflow](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows)
|
|
|
with the following branches
|
|
|
with the following main branches:
|
|
|
|
|
|
| Branch name | Description |
|
|
|
| Branch name | Description |
|
|
|
|-------------|---------------|
|
|
|
| `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. |
|
... | ... | @@ -44,19 +46,19 @@ _develop_, there is ***no*** guarantee of continuity. |
|
|
### Exploring projects
|
|
|
|
|
|
- From the projects menu you can navigate through various projects as shown below.
|
|
|
![GitLab All projects](images/KB-GL-ADV-AllProjects.png)
|
|
|
![GitLab All projects](/images/KB-GL-ADV-AllProjects.png)
|
|
|
|
|
|
- Selecting a project, e.g. OpenFOAM, ThirdParty, 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)
|
|
|
![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.
|
|
|
![GitLab notification settings](images/KB-GL-ADV-project-notification.png)
|
|
|
![GitLab notification settings](/images/KB-GL-ADV-project-notification.png)
|
|
|
|
|
|
- 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)
|
|
|
![GitLab download options](/images/KB-GL-ADV-project-download.png)
|
|
|
|
|
|
- Alternatively, browse a repository for files, branches, tags, etc. via the Repository section:
|
|
|
![GitLab repository view](images/KB-GL-ADV-OpenFOAM-repository-view.png)
|
|
|
![GitLab repository view](/images/KB-GL-ADV-OpenFOAM-repository-view.png)
|
|
|
|
|
|
|
|
|
### Terminal mode (cloning)
|
... | ... | @@ -65,7 +67,7 @@ _develop_, there is ***no*** guarantee of continuity. |
|
|
|
|
|
- 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:
|
|
|
|
|
|
![GitLab clone address](images/KB-GL-ADV-project-clone-address.png)
|
|
|
![GitLab clone address](/images/KB-GL-ADV-project-clone-address.png)
|
|
|
|
|
|
- Clone the default _master_ branch via HTTPS using
|
|
|
```
|
... | ... | @@ -132,7 +134,7 @@ git fetch |
|
|
- A confirmation email will be sent to the registered address (check the spam folder if no emails are received after a few minutes)
|
|
|
- Follow the link to complete the sign-up process
|
|
|
|
|
|
![GitLab User Registration](images/KB-GL-ADV-Register.png)
|
|
|
![GitLab User Registration](/images/KB-GL-ADV-Register.png)
|
|
|
|
|
|
|
|
|
#### Adding a SSH key
|
... | ... | @@ -142,10 +144,15 @@ settings 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-AddSSHKey.png)
|
|
|
![GitLab Add SSH key](/images/KB-GL-ADV-AddSSHKey.png)
|
|
|
|
|
|
|
|
|
[foam-repo]: https://develop.openfoam.com/Development/openfoam/
|
|
|
[third-repo]: https://develop.openfoam.com/Development/ThirdParty-common/
|
|
|
|
|
|
[foam-issues]: https://develop.openfoam.com/Development/openfoam/-/issues
|
|
|
[third-issues]: https://develop.openfoam.com/Development/ThirdParty-common/-/issues
|
|
|
|
|
|
[foam-repo]: https://develop.openfoam.com/Development/openfoam/
|
|
|
[master]: https://develop.openfoam.com/Development/openfoam/tree/master
|
|
|
[develop]: https://develop.openfoam.com/Development/openfoam/tree/develop
|
|
|
|
... | ... | |