Improve deploy-data flexibility to deploy files from other checkout i…

…n same config file (#462)

## Overview

This is a non breaking change.

Given the config file can specify multiple checkouts, this flexibility
to
have `SRC_DIR` be an absolute path will allow one checkout to take files
from
other checkouts, using absolute path to the other checkouts. `SRC_DIR`
can
still be a relative path of the current checkout, as before, to preserve
  backward-compatibility.

Possible use-case: re-organize the layout of various files from the
various
checkouts in an intermediate location before rsyncing this intermediate
  location to the final destination.

## CI Operations

<!--
The test suite can be run using a different DACCS config with
``birdhouse_daccs_configs_branch: branch_name`` in the PR description.
To globally skip the test suite regardless of the commit message use
``birdhouse_skip_ci`` set to ``true`` in the PR description.
Note that using ``[skip ci]``, ``[ci skip]`` or ``[no ci]`` in the
commit message will override ``birdhouse_skip_ci`` from the PR
description.
-->

birdhouse_daccs_configs_branch: master
birdhouse_skip_ci: false

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.4.1
+current_version = 2.4.2
 commit = True
 tag = False
 tag_name = {new_version}
@@ -30,11 +30,11 @@ search = {current_version}
 replace = {new_version}
 
 [bumpversion:file:RELEASE.txt]
-search = {current_version} 2024-06-05T22:22:08Z
+search = {current_version} 2024-06-12T20:14:03Z
 replace = {new_version} {utcnow:%Y-%m-%dT%H:%M:%SZ}
 
 [bumpversion:part:releaseTime]
-values = 2024-06-05T22:22:08Z
+values = 2024-06-12T20:14:03Z
 
 [bumpversion:file(version):birdhouse/components/canarie-api/docker_configuration.py.template]
 search = 'version': '{current_version}'

CHANGES.md

@@ -17,6 +17,23 @@
 
 [//]: # (list changes here, using '-' for each new entry, remove this when items are added)
 
+[2.4.2](https://github.com/bird-house/birdhouse-deploy/tree/2.4.2) (2024-06-12)
+------------------------------------------------------------------------------------------------------------------
+
+## Changes
+- deploy-data: allow more flexibility to deploy files from other checkout in same config file
+
+  Given the config file can specify multiple checkouts, this flexibility to
+  have `SRC_DIR` be an absolute path will allow one checkout to take files from
+  other checkouts, using absolute path to the other checkouts.  `SRC_DIR` can
+  still be a relative path of the current checkout, as before, to preserve
+  backward-compatibility.
+
+  Possible use-case: re-organize the layout of various files from the various
+  checkouts in an intermediate location before rsyncing this intermediate
+  location to the final destination.
+
+
 [2.4.1](https://github.com/bird-house/birdhouse-deploy/tree/2.4.1) (2024-06-05)
 ------------------------------------------------------------------------------------------------------------------
 

Makefile

@@ -1,7 +1,7 @@
 # Generic variables
 override SHELL       := bash
 override APP_NAME    := birdhouse-deploy
-override APP_VERSION := 2.4.1
+override APP_VERSION := 2.4.2
 
 # utility to remove comments after value of an option variable
 override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")

README.rst

@@ -18,13 +18,13 @@ for a full-fledged production platform.
     * - citation
       - | |citation|
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.4.1.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.4.2.svg
     :alt: Commits since latest release
-    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.4.1...master
+    :target: https://github.com/bird-house/birdhouse-deploy/compare/2.4.2...master
 
-.. |latest-version| image:: https://img.shields.io/badge/tag-2.4.1-blue.svg?style=flat
+.. |latest-version| image:: https://img.shields.io/badge/tag-2.4.2-blue.svg?style=flat
     :alt: Latest Tag
-    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.4.1
+    :target: https://github.com/bird-house/birdhouse-deploy/tree/2.4.2
 
 .. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
     :alt: ReadTheDocs Build Status (latest version)

RELEASE.txt

@@ -1 +1 @@
-2.4.1 2024-06-05T22:22:08Z
+2.4.2 2024-06-12T20:14:03Z

birdhouse/components/canarie-api/docker_configuration.py.template

@@ -108,8 +108,8 @@ SERVICES = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '2.4.1',
-            'releaseTime': '2024-06-05T22:22:08Z',
+            'version': '2.4.2',
+            'releaseTime': '2024-06-12T20:14:03Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',
@@ -141,8 +141,8 @@ PLATFORMS = {
             # NOTE:
             #   Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
             #   Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
-            'version': '2.4.1',
-            'releaseTime': '2024-06-05T22:22:08Z',
+            'version': '2.4.2',
+            'releaseTime': '2024-06-12T20:14:03Z',
             'institution': '${BIRDHOUSE_INSTITUTION}',
             'researchSubject': '${BIRDHOUSE_SUBJECT}',
             'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',

birdhouse/deployment/deploy-data

@@ -151,6 +151,14 @@ for GIT_REPO_URL in $GIT_REPO_URLS; do
         echo "sync '$SRC_DIR' to '$DEST_DIR'"
         DEST_DIR_PARENT="`dirname "$DEST_DIR"`"
         SRC_DIR_ABS_PATH="`pwd`/$SRC_DIR"
+        if [ ! -e "$SRC_DIR_ABS_PATH" ]; then
+            # SRC_DIR could already be absolute.
+            # Support rsync from source outside of current checkout, ex: from
+            # other checkouts in same config file because config file can have
+            # multiple checkouts or from intermediate location used to
+            # re-organize the layout before the final rsync to destination.
+            SRC_DIR_ABS_PATH="$SRC_DIR"
+        fi
         USER_ID="`id -u`"
         GROUP_ID="`id -g`"
         RSYNC_USER_GRP="$USER_ID:$GROUP_ID"

docs/source/conf.py

@@ -69,9 +69,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.4.1'
+version = '2.4.2'
 # The full version, including alpha/beta/rc tags.
-release = '2.4.1'
+release = '2.4.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.