Skip to content

Commit 26d2c90

Browse files
Incorrect usage checks for birdhouse backup create (#632)
## Overview Running `birdhouse backup create` was failing without either the `--no-restic` or `--snapshot` options specified. However, `--snapshot` is only required for the `restore` subargument (not `create`) and so `create` would often fail with a confusing error message. This fixes the issue by moving the check so that it is only triggered when restoring a backup. ## Changes **Non-breaking changes** - Bug fix **Breaking changes** ## Related Issue / Discussion ## Additional Information Links to other issues or sources. - [ ] Things to do... ## 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. Using ``[<cmd>]`` (with the brackets) where ``<cmd> = skip ci`` in the commit message will override ``birdhouse_skip_ci`` from the PR description. Such commit command can be used to override the PR description behavior for a specific commit update. However, a commit message cannot 'force run' a PR which the description turns off the CI. To run the CI, the PR should instead be updated with a ``true`` value, and a running message can be posted in following PR comments to trigger tests once again. --> birdhouse_daccs_configs_branch: master birdhouse_skip_ci: false
2 parents 49f58ce + 3bc0290 commit 26d2c90

File tree

8 files changed

+31
-19
lines changed

8 files changed

+31
-19
lines changed

.bumpversion.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tool.bumpversion]
2-
current_version = "2.20.2"
2+
current_version = "2.20.3"
33
commit = true
44
tag = false
55
tag_name = "{new_version}"

CHANGES.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
[Unreleased](https://github.com/bird-house/birdhouse-deploy/tree/master) (latest)
1616
------------------------------------------------------------------------------------------------------------------
1717

18+
[//]: # (list changes here, using '-' for each new entry, remove this when items are added)
19+
20+
[2.20.3](https://github.com/bird-house/birdhouse-deploy/tree/2.20.3) (2026-01-13)
21+
------------------------------------------------------------------------------------------------------------------
22+
1823
## Fixes
1924

2025
- Fix bugs in `get-components-json.include.sh` and simplify `get-services-json.include.sh`
@@ -27,6 +32,14 @@
2732
- removed unnecessary variable declarations
2833
- simplify component discovery `get-components-json.include.sh`
2934

35+
- Incorrect usage checks for `birdhouse backup create`
36+
37+
Running `birdhouse backup create` was failing without either the `--no-restic` or `--snapshot` options specified.
38+
However, `--snapshot` is only required for the `restore` subargument (not `create`) and so `create` would often
39+
fail with a confusing error message.
40+
41+
This fixes the issue by moving the check so that it is only triggered when restoring a backup.
42+
3043
[2.20.2](https://github.com/bird-house/birdhouse-deploy/tree/2.20.2) (2026-01-05)
3144
------------------------------------------------------------------------------------------------------------------
3245

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ override BIRDHOUSE_MAKE_DIR := $(shell realpath -P $$(dirname $(BIRDHOUSE_MAKE_C
88
# Generic variables
99
override SHELL := bash
1010
override APP_NAME := birdhouse-deploy
11-
override APP_VERSION := 2.20.2
11+
override APP_VERSION := 2.20.3
1212

1313
# utility to remove comments after value of an option variable
1414
override clean_opt = $(shell echo "$(1)" | $(_SED) -r -e "s/[ '$'\t'']+$$//g")

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ for a full-fledged production platform.
1818
* - citation
1919
- | |citation|
2020

21-
.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.20.2.svg
21+
.. |commits-since| image:: https://img.shields.io/github/commits-since/bird-house/birdhouse-deploy/2.20.3.svg
2222
:alt: Commits since latest release
23-
:target: https://github.com/bird-house/birdhouse-deploy/compare/2.20.2...master
23+
:target: https://github.com/bird-house/birdhouse-deploy/compare/2.20.3...master
2424

25-
.. |latest-version| image:: https://img.shields.io/badge/tag-2.20.2-blue.svg?style=flat
25+
.. |latest-version| image:: https://img.shields.io/badge/tag-2.20.3-blue.svg?style=flat
2626
:alt: Latest Tag
27-
:target: https://github.com/bird-house/birdhouse-deploy/tree/2.20.2
27+
:target: https://github.com/bird-house/birdhouse-deploy/tree/2.20.3
2828

2929
.. |readthedocs| image:: https://readthedocs.org/projects/birdhouse-deploy/badge/?version=latest
3030
:alt: ReadTheDocs Build Status (latest version)

RELEASE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.20.2 2026-01-05T18:34:59Z
1+
2.20.3 2026-01-13T15:45:06Z

bin/birdhouse

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -377,13 +377,7 @@ check_backup_create_args() {
377377
"BIRDHOUSE_BACKUP_VOLUME must be specified." \
378378
"${BACKUP_CREATE_USAGE}"
379379
fi
380-
[ -n "${BIRDHOUSE_BACKUP_RESTORE_SNAPSHOT}" ] || \
381-
[ "${BIRDHOUSE_BACKUP_NO_RESTIC}" = 'true' ] || \
382-
log_error_help \
383-
'Use the -s|--snapshot option to specify a snapshot to restore with restic or --no-restic to employ BIRDHOUSE_BACKUP_VOLUME directly.' \
384-
"${BACKUP_CREATE_USAGE}"
385380
if
386-
[ -z "${BIRDHOUSE_BACKUP_RESTORE_SNAPSHOT}" ] && \
387381
[ "${BIRDHOUSE_BACKUP_NO_RESTIC}" = 'true' ] && \
388382
[ $(echo "${BIRDHOUSE_BACKUP_VOLUME}" | grep -c '/' || true) -eq 0 ]; then
389383
log WARN \
@@ -399,6 +393,11 @@ check_backup_restore_args() {
399393
"BIRDHOUSE_BACKUP_VOLUME must be specified." \
400394
"${BACKUP_RESTORE_USAGE}"
401395
fi
396+
[ -n "${BIRDHOUSE_BACKUP_RESTORE_SNAPSHOT}" ] || \
397+
[ "${BIRDHOUSE_BACKUP_NO_RESTIC}" = 'true' ] || \
398+
log_error_help \
399+
'Use the -s|--snapshot option to specify a snapshot to restore with restic or --no-restic to restore from BIRDHOUSE_BACKUP_VOLUME directly.' \
400+
"${BACKUP_CREATE_USAGE}"
402401
if [ "${BIRDHOUSE_BACKUP_NO_RESTIC}" = 'true' ]; then
403402
if [ $(echo "${BIRDHOUSE_BACKUP_VOLUME}" | grep -c '/' || true) -eq 0 ]; then
404403
log WARN \

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ SERVICES = {
108108
# NOTE:
109109
# Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
110110
# Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
111-
'version': '2.20.2',
112-
'releaseTime': '2026-01-05T18:34:59Z',
111+
'version': '2.20.3',
112+
'releaseTime': '2026-01-13T15:45:06Z',
113113
'institution': '${BIRDHOUSE_INSTITUTION}',
114114
'researchSubject': '${BIRDHOUSE_SUBJECT}',
115115
'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',
@@ -141,8 +141,8 @@ PLATFORMS = {
141141
# NOTE:
142142
# Below version and release time auto-managed by 'make VERSION=x.y.z bump'.
143143
# Do NOT modify it manually. See 'Tagging policy' in 'birdhouse/README.rst'.
144-
'version': '2.20.2',
145-
'releaseTime': '2026-01-05T18:34:59Z',
144+
'version': '2.20.3',
145+
'releaseTime': '2026-01-13T15:45:06Z',
146146
'institution': '${BIRDHOUSE_INSTITUTION}',
147147
'researchSubject': '${BIRDHOUSE_SUBJECT}',
148148
'supportEmail': '${BIRDHOUSE_SUPPORT_EMAIL}',

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@
6969
# built documents.
7070
#
7171
# The short X.Y version.
72-
version = '2.20.2'
72+
version = '2.20.3'
7373
# The full version, including alpha/beta/rc tags.
74-
release = '2.20.2'
74+
release = '2.20.3'
7575

7676
# The language for content autogenerated by Sphinx. Refer to documentation
7777
# for a list of supported languages.

0 commit comments

Comments
 (0)