| | 4 | We plan to make release versions of Eden. |
| | 5 | |
| | 6 | This will entail: |
| | 7 | * Creating a QA branch |
| | 8 | - features have final integration testing done here before being pushed to the Stable branch |
| | 9 | * Creating a Stable branch |
| | 10 | - deployments should be done from this branch |
| | 11 | * Adding Tags to Releases |
| | 12 | * Building upgrade scripts |
| | 13 | |
| | 14 | == Tagging == |
| | 15 | Tags will be added based on the following schema: |
| | 16 | {{{ |
| | 17 | [BranchName]-[Major].[Minor].[Sub] |
| | 18 | }}} |
| | 19 | The VERSION string will include the Tag + the number of commits since the last tag + the hash of the commit |
| | 20 | |
| | 21 | The Major release number will only change if we: |
| | 22 | * change the API in backward-incompatible ways |
| | 23 | * release a new trunk |
| | 24 | |
| | 25 | The Minor release number indicates the normal release. |
| | 26 | [[BR]]These will often require an update script |
| | 27 | |
| | 28 | The Sub release number indicates an update to the release. |
| | 29 | Sub-releases can introduce new features, but they would normally not: |
| | 30 | - replace feature sets |
| | 31 | - remove feature sets |
| | 32 | - fundamentally change the logic/semantics of a feature set |
| | 33 | Sub-releases may still require an upgrade script |
| | 34 | |
| | 35 | Git docs on Tags: |
| | 36 | * https://git-scm.com/book/en/v2/Git-Basics-Tagging |
| | 37 | |
| | 38 | === Branch Tags === |
| | 39 | If a Branch of the code is made on GitHub to manage releasesfor a deployment, then it's version will be appended to that of the Stable branch, so |
| | 40 | {{{ |
| | 41 | [BranchName]-[Major].[Minor].[Sub]-[BranchRelease].[Sub] |
| | 42 | }}} |
| | 43 | |
| | 44 | == Upgrade Scripts == |
| | 45 | For every update that requires it, an Upgrade script will be added to: |
| | 46 | {{{ |
| | 47 | eden/static/scripts/upgrade/1.a.b-1.a.c.py |
| | 48 | }}} |
| | 49 | The 'pull' script will be modified to call this script automatically |
| | 50 | |
| | 51 | === Template Upgrade Scripts === |
| | 52 | If there are template-specific changes for an update then these will be found in: |
| | 53 | {{{ |
| | 54 | eden/modules/templates/TEMPLATE/upgrade/1.a.b-1.a.c.py |
| | 55 | }}} |
| | 56 | This will be checked for automatically by the 'pull' script |
| | 57 | |
| | 58 | === Branch Upgrade Scripts === |
| | 59 | Typically a Branch will be using a custom Template (even if this is a thin layer on top of other templates). |
| | 60 | |
| | 61 | Branch upgrade scripts will therefore be in: |
| | 62 | {{{ |
| | 63 | eden/modules/templates/TEMPLATE/upgrade/1.a.b_d.e-1.a.b_d.e.py |
| | 64 | or |
| | 65 | eden/modules/templates/TEMPLATE/upgrade/1.a.b_d.e-1.a.c_d.e.py |
| | 66 | }}} |
| | 67 | This will be checked for automatically by the 'pull' script. |
| | 68 | |
| | 69 | If there is no branch-specific upgrade script yet there is one for the underlying stable upgrade then the pull script should detect this & allow the user to run this instead of nothing or bail & revert. |
| | 70 | |
| | 71 | == Old Info == |