... | ... | @@ -7,15 +7,13 @@ Many are **public-access** and can be downloaded or cloned directly; |
|
|
to access other internal repositories and take advantage of advanced
|
|
|
features (such as reporting issues), users must create an account.
|
|
|
|
|
|
The main repositories:
|
|
|
- The [OpenFOAM repository](https://develop.openfoam.com/Development/openfoam/)
|
|
|
with [issue tracker](https://develop.openfoam.com/Development/openfoam/issues)
|
|
|
- The [ThirdParty repository](https://develop.openfoam.com/Development/ThirdParty-common/)
|
|
|
with [issue tracker](https://develop.openfoam.com/Development/ThirdParty-common/issues)
|
|
|
| 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) |
|
|
|
|
|
|
If you have been using the [older OpenFOAM git repository][old-foam-repo]
|
|
|
and have code you need to migrate, you should see the [repository
|
|
|
migration](Repository-migration) information.
|
|
|
_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._
|
|
|
|
|
|
|
|
|
## Organization of git branches
|
... | ... | @@ -24,21 +22,21 @@ The OpenFOAM repository follows a |
|
|
[branching workflow](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows)
|
|
|
with the following branches
|
|
|
|
|
|
- `master`: bugfix updates since the last release, should always be runnable/stable code (can be used in production)
|
|
|
- `develop`: current developments, waiting to be pushed into the master prior to a new release.
|
|
|
The code in develop is generally quite stable, but regressions may occasionally occur.
|
|
|
- `maintenance-v1812`, _etc_: bugfix branches for previous releases.
|
|
|
When a new code version is released, `master`
|
|
|
is renamed `maintenance-{prevRelease}` and a new `master` is created at release.
|
|
|
- `feature-XYZ`: a work-in-progress feature branch. Mostly for internal use.
|
|
|
| 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. |
|
|
|
| `maintenance-v1906` ... | 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.
|
|
|
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
|
|
|
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 additionally is guarantee of continuity.
|
|
|
_develop_, there is ***no*** guarantee of continuity.
|
|
|
|
|
|
|
|
|
## Exploring projects
|
... | ... | |