Differences

This shows you the differences between two versions of the page.

--- dev:release_process:evergreen:how_to_build [2024/10/22 10:51] – [Install packager dependencies] sandbergja
+++ dev:release_process:evergreen:how_to_build [2025/02/10 16:53] (current) – [Helpful videos] aneiman
@@ Line 10: / Line 10: @@
   * Nov 2023 [[https://drive.google.com/file/d/1G0niyLAh55_mkgJVGn1GLFGHl_zEltcJ/view|Building 3.12, first session]]
   * Dec 2023 [[https://princeton.zoom.us/rec/play/zDAyi7Y852mQys4Y7txxJz8fpLooM9zbz3iosP9Ex-ulHmlQ0iSWXfe-5vB-9ke_WRT-HbMYAOsHvoEO.YiWoiCK3_85oGQxf?canPlayFromShare=true&from=share_recording_detail&continueMode=true&componentName=rec-play&originRequestUrl=https%3A%2F%2Fprinceton.zoom.us%2Frec%2Fshare%2Fwrmq5l5oEMGQyzXFJiXoww0NlAK3cH8sH4amQOrE9jO0hsSjZfcl2GGzTz9y9aL4.LybQWetrF2AEXvje|Building 3.12, second session]]
+  * Feb 2025 [[https://youtu.be/PV1R8o8GFoI?si=ZLBRfKFWqOPgz4CV|3.15 Build Q&A]]
 ==== Prerequisites ====
 Make sure you are in an environment with your git ssh keys, since you will need to be pushing commits to the git server.
+Make sure that you have OpenSRF installed in your environment.
 To upload translations to Launchpad, you will also need to register an ssh key with Launchpad. See the [[https://code.launchpad.net/~evergreen-bugs/evergreen/translation-export-3.13|3.13 translation page for an example]].
@@ Line 30: / Line 33: @@
 [Note that your Ubuntu version may be something other than 'jammy', or you may be using a different OS altogether. Substitute the appropriate version keyword -- if you don't know your Ubuntu version off the top of your head, you can check the /etc/lsb-release file]
+==== Confirm git credentials and username/email ====
+The following steps will require you to commit your work and push to a remote git repository.  If you are using a different environment than you usually use (for example, a fresh Docker container or new VM), make sure the following are correct.
+If you are using a docker dev container, You can commit from inside the container, but push from the host machine -- if you choose this approach, you should make sure the first two commands work from within the container, and the last two commands work from your host machine.
+^ Setting                                                                                                                      ^ How to check it                                                                                                                                                                  ^ How to fix it                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| Your user name                                                                                                               | Run the command: ''git config user.name'' and confirm that your name displays                                                                                                    | Run the command: ''git config --global user.name "My Name"''                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| Your email address                                                                                                           | Run the command: ''git config user.email'' and confirm that your email displays                                                                                                  | Run the command: ''git config --global user.email me@example.com''                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| The git remote you intend to push to (the Evergreen repo if you are a committer, the working/Evergreen repo if you are not)  | Run the command: ''git remote -v''.  Confirm that it includes ''git@git.evergreen-ils.org:Evergreen.git''  or ''git@git.evergreen-ils.org:working/Evergreen.git'' as a push url  | Run a command like: ''git remote add working git@git.evergreen-ils.org:working/Evergreen.git''                                                                                                                                                                                                                                                                                                                                                                                      |
+| Your SSH key to connect to the git remote                                                                                    | Run the command ''git ls-remote''.  Confirm that it does not ask for ''git@git.evergreen-ils.org's password''                                                                    | Securely copy or mount your private SSH key into the environment you will be using to push.  For example, if you are creating a docker container for your work, you can add the flag ''-v ~/.ssh:/home/opensrf/.ssh'' to your ''docker run'' command to mount your .ssh directory.  If you copy your private key to the VM or container, be sure to remove it or destroy the VM/container when you are done, since this key could allow somebody else to impersonate you.  |
 ==== Update relator codes (requires commit bit) ====
@@ Line 134: / Line 148: @@
 <code bash>
-# series here is "main" or "3.10" or whatever corresponding to the release
+# series here is "main" or "3.13" or whatever corresponding to the release
 # that you are building
 $ Evergreen/build/i18n/scripts/update_pofiles -l translation-export-SERIES -e Evergreen
@@ Line 197: / Line 211: @@
 <code bash>
 # copy README and release notes to ../release/
-$ export RELEASE=3_12
+$ export RELEASE=3_12_0 # Increment for later release, 3_12_1 for example.
 $ cp README ../release/README_$RELEASE
 $ cp docs/RELEASE_NOTES_$RELEASE.adoc ../release/
@@ Line 214: / Line 228: @@
 Move the release files into the correct download directories on the evergreen-ils.org web server (which is also known as lupin):
     * Previews / alphas / betas / release candidates go in ''/var/www/open-ils.org/downloads/previews/''
-    * Final releases and ChangeLog-* go in ''/var/www/open-ils.org/downloads/''
+    * Final releases go in ''/var/www/open-ils.org/downloads/''
     * Install docs / README_* go in ''/var/www/open-ils.org/documentation/install/''
     * Release notes go in ''/var/www/open-ils.org/documentation/release/''