dev:release_process:evergreen:how_to_build
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
dev:release_process:evergreen:how_to_build [2024/05/13 14:43] – aneiman | dev:release_process:evergreen:how_to_build [2024/05/16 10:52] – [Upload to web server (requires access to the evergreen-ils.org web server)] gmcharlton | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Rolling an Evergreen Release ===== | + | ====== Rolling an Evergreen Release |
**¡This is a work in progress. | **¡This is a work in progress. | ||
Line 60: | Line 60: | ||
$ find . -mindepth 2 -name ' | $ find . -mindepth 2 -name ' | ||
$ find . -mindepth 2 -name ' | $ find . -mindepth 2 -name ' | ||
+ | $ echo "" | ||
</ | </ | ||
Line 89: | Line 90: | ||
<code bash>$ vi docs/ | <code bash>$ vi docs/ | ||
+ | ==== Translations, | ||
+ | |||
+ | This needs to be done once during the release cycle, typically at alpha or beta | ||
+ | |||
+ | Set up the new series branch using the instructions here: [[i18n: | ||
==== Translations, | ==== Translations, | ||
- | * First, set up the new series branch using the instructions here: [[i18n: | + | During each release starting with beta, get the latest template changes and apply them to the main branch you are working from in origin (main/ |
- | * During each release starting with beta, get the latest template changes and apply them to the main branch you are working from in origin (main/ | + | |
- | * Update pot in Evergreen <code bash>$ cd build/i18n && make newpot</ | + | |
- | * From the Evergreen directory, run the python script to commit any changes that do more than modify metadata <code bash> | + | * From the Evergreen directory, run the python script to commit any changes that do more than modify metadata <code bash> |
==== Translations, | ==== Translations, | ||
- | * Export strings for the Angular staff client and import them into POEditor, following these [[: | ||
- | ==== Setting up your git branch ==== | + | Export strings for the Angular staff client and import them into POEditor, following the [[: |
- | * Create a local working | + | ==== Setting up your git branch |
+ | Create a local working branch for the release. | ||
<code bash>$ git checkout -b tags/ | <code bash>$ git checkout -b tags/ | ||
Line 144: | Line 150: | ||
==== Other version number changes ==== | ==== Other version number changes ==== | ||
- | * Edit ./ | + | * Edit ./ |
<code perl> | <code perl> | ||
- | our $VERSION = '3.0101'; | + | our $VERSION = '3.1300'; |
</ | </ | ||
- | * NOTE: The version string is two digits for each level after the decimal, so for example " | + | * NOTE: The version string is two digits for each level after the decimal, so for example " |
* Commit the version change | * Commit the version change | ||
<code bash> | <code bash> | ||
- | $ git commit -asm " | + | $ git commit -asm " |
</ | </ | ||
Line 160: | Line 166: | ||
* Replace release version placeholders (X.X.X) with the actual version numbers in docs/ | * Replace release version placeholders (X.X.X) with the actual version numbers in docs/ | ||
- | * * In vim, '': | + | |
- | * If you are creating a beta or rc, add a hyphen and then beta or rc. For example, 3.12-rc. | + | * If you are creating a beta or rc, add a hyphen and then beta or rc. For example, 3.13-rc. |
* Replace the previous version placeholder (e.g. 3.X.W) with the last release number. | * Replace the previous version placeholder (e.g. 3.X.W) with the last release number. | ||
- | * * In vim, '': | + | |
* Double check the correct minimum version of OpenSRF. | * Double check the correct minimum version of OpenSRF. | ||
* If the minimum version of OpenSRF has changed, also update the OpenSRF version number in docs/ | * If the minimum version of OpenSRF has changed, also update the OpenSRF version number in docs/ | ||
Line 169: | Line 175: | ||
==== Run the release builder script ==== | ==== Run the release builder script ==== | ||
- | * Run the release builder script | + | Run the release builder script: |
<code bash> | <code bash> | ||
$ export PATH=$PATH:/ | $ export PATH=$PATH:/ | ||
- | $ build/ | + | $ build/ |
</ | </ | ||
- | * Additional notes on make_release options: | + | Additional notes on make_release options: |
- | * Use the -v flag when your branch name does not match the normal pattern, otherwise auto-detect works | + | * If you are building beta, use -beta for the first version value, for example: 3.13-beta. |
- | * Use the -j flag to point at wherever your OpenSRF javascript lib source is, if not already installed | + | * Use the highest numbered previous version for the second version value. |
- | * -j ~/ | + | |
- | * The -f flag sets the branch " | + | * For a .0 release, the script should start from (probably) the release candidate: <code bash>$ build/ |
- | * You can add the -r option to edit the upgrade script before it goes into the tarball. This may be necessary if tables that get altered in the upgrade scripts also have updates or inserts of new data. | + | * For a point release, the script should start from the previous point release in the series: <code bash>$ build/ |
- | * Enhanced Concerto Dataset upgrade *experimental | + | |
- | * This is optional, but if enough of the database tables have changed, it's a good idea. | + | * Use the -j flag to point at wherever your OpenSRF javascript lib source is, if not already installed |
- | * -H < | + | * -j ~/ |
- | * -U < | + | * The -f flag sets the branch " |
- | * -P < | + | * You can add the -r option to edit the upgrade script before it goes into the tarball. This may be necessary if tables that get altered in the upgrade scripts also have updates or inserts of new data. |
- | * -O < | + | * Enhanced Concerto Dataset upgrade *experimental |
- | * Omitting -H will cause make_release to skip the enhanced concerto upgrade steps. | + | * This is optional, but if enough of the database tables have changed, it's a good idea. |
+ | * -H < | ||
+ | * -U < | ||
+ | * -P < | ||
+ | * -O < | ||
+ | * Omitting -H will cause make_release to skip the enhanced concerto upgrade steps. | ||
Note that you will get a lot of warnings related to the po translation files. | Note that you will get a lot of warnings related to the po translation files. | ||
Line 219: | Line 230: | ||
* Release notes go in ''/ | * Release notes go in ''/ | ||
+ | Because the release notes document is cumulative for each release series, a symbolic link exists for each release series so that (e.g.) '' | ||
+ | |||
+ | When updating the downloads page to the website, the URL should use the symbolic link, not the release notes for the specific release, e.g., '' | ||
==== " | ==== " | ||
<code bash> | <code bash> | ||
- | git push origin tags/rel_3_12_1:tags/rel_3_12_1 | + | git push origin tags/rel_3_13_0:tags/rel_3_13_0 |
</ | </ | ||
dev/release_process/evergreen/how_to_build.txt · Last modified: 2024/09/30 12:55 by dyrcona