| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
| development:git-branches [2023/02/24 13:25] – demiankatz | development:git-branches [2023/11/16 16:19] – demiankatz |
|---|
| ====== Useful Git Branches ====== | ====== Useful Git Branches ====== |
| |
| Some features are not available in the core VuFind® distribution, either because they have been deprecated, because they have not been released yet, or because the VuFind® team has not yet committed to maintaining them in the long term. These features are maintained in separate branches in the VuFind® GitHub repository and may be merged in manually if they meet your local needs. | The VuFind® project uses [[development:recommended_tools:git|Git]] to manage development. This page describes our branching strategies. |
| |
| ===== Key Branches and Tags ===== | ===== Key Branches and Tags ===== |
| * If you want to get an exact release from a specific point in time, use the "vx.y.z" tag. | * If you want to get an exact release from a specific point in time, use the "vx.y.z" tag. |
| |
| ===== Feature Branches ===== | ===== Other Branches ===== |
| | |
| | Some features are not available in the core VuFind® distribution, either because they have been deprecated, because they have not been released yet, or because the VuFind® team has not yet committed to maintaining them in the long term. These features are maintained in separate branches in the VuFind® GitHub repository and may be merged in manually if they meet your local needs. |
| | |
| | ==== Feature Branches ==== |
| |
| Features that may be useful but which the core VuFind® team is not yet ready to fully support are given feature branches. | Features that may be useful but which the core VuFind® team is not yet ready to fully support are given feature branches. |
| |
| | * [[https://github.com/vufind-org/vufind/tree/feature/consume-whitespace|feature/consume-whitespace]] - This adds a post-processor to allow templates to include a special tag for consuming whitespace (submitted via [[https://github.com/vufind-org/vufind/pull/2374|pull request #2374]]). It was not adopted as a core feature but may be useful in the future. |
| * [[https://github.com/vufind-org/vufind/tree/feature/foundation5|feature/foundation5]] - This adds a new theme based on the [[http://foundation.zurb.com/|Foundation]] framework. See the [[development:git-branches:foundation5_theme|Foundation5 Theme]] page for details. | * [[https://github.com/vufind-org/vufind/tree/feature/foundation5|feature/foundation5]] - This adds a new theme based on the [[http://foundation.zurb.com/|Foundation]] framework. See the [[development:git-branches:foundation5_theme|Foundation5 Theme]] page for details. |
| * [[https://github.com/vufind-org/vufind/tree/feature/heroku|feature/heroku]] - This adds experimental support for running VuFind® on [[https://www.heroku.com/|Heroku]]. Not all features are supported. See [[https://github.com/vufind-org/vufind/pull/913|#913]] for details. | * [[https://github.com/vufind-org/vufind/tree/feature/heroku|feature/heroku]] - This adds experimental support for running VuFind® on [[https://www.heroku.com/|Heroku]]. Not all features are supported. See [[https://github.com/vufind-org/vufind/pull/913|#913]] for details. |
| * [[https://github.com/vufind-org/vufind/tree/feature/text-only-theme|feature/text-only-theme]] - A stripped-down, text-only theme for extreme bandwidth situations. Inspired by [[https://text.npr.org/]]. | * [[https://github.com/vufind-org/vufind/tree/feature/text-only-theme|feature/text-only-theme]] - A stripped-down, text-only theme for extreme bandwidth situations. Inspired by [[https://text.npr.org/]]. |
| ===== Legacy Branches ===== | |
| | ==== Legacy Branches ==== |
| |
| Features that have been deprecated and removed from dev are given "legacy" branches where volunteers are free to keep them up to date with dev if they need to do so. Feel free to issue pull requests against the legacy branches if you wish to help keep them up to date. | Features that have been deprecated and removed from dev are given "legacy" branches where volunteers are free to keep them up to date with dev if they need to do so. Feel free to issue pull requests against the legacy branches if you wish to help keep them up to date. |
