A wrapper script for Borg backup software that creates and prunes backups
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

338 lines
14 KiB

  1. 1.3.2
  2. * #160: Fix for hooks executing when using --dry-run. Now hooks are skipped during a dry run.
  3. 1.3.1
  4. * #155: Fix for invalid JSON output when using multiple borgmatic configuration files.
  5. * #157: Fix for seemingly random filename ordering when running through a directory of
  6. configuration files.
  7. * Fix for empty JSON output when using --create --json.
  8. * Now capturing Borg output only when --json flag is used. Previously, borgmatic delayed Borg
  9. output even without the --json flag.
  10. 1.3.0
  11. * #148: Configuration file includes and merging via "!include" tag to support reuse of common
  12. options across configuration files.
  13. 1.2.18
  14. * #147: Support for Borg create/extract --numeric-owner flag via "numeric_owner" option in
  15. borgmatic's location section.
  16. 1.2.17
  17. * #140: List the files within an archive via --list --archive option.
  18. 1.2.16
  19. * #119: Include a sample borgmatic configuration file in the documentation.
  20. * #123: Support for Borg archive restoration via borgmatic --extract command-line flag.
  21. * Refactor documentation into multiple separate pages for clarity and findability.
  22. * Organize options within command-line help into logical groups.
  23. * Exclude tests from distribution packages.
  24. 1.2.15
  25. * #127: Remove date echo from schema example, as it's not a substitute for real logging.
  26. * #132: Leave exclude_patterns glob expansion to Borg, since doing it in borgmatic leads to
  27. confusing behavior.
  28. * #136: Handle and format validation errors raised during argument parsing.
  29. * #138: Allow use of --stats flag when --create or --prune flags are implied.
  30. 1.2.14
  31. * #103: When generating sample configuration with generate-borgmatic-config, document the defaults
  32. for each option.
  33. * #116: When running multiple configuration files, attempt all configuration files even if one of
  34. them errors. Log a summary of results at the end.
  35. * Add borgmatic --version command-line flag to get the current installed version number.
  36. 1.2.13
  37. * #100: Support for --stats command-line flag independent of --verbosity.
  38. * #117: With borgmatic --init command-line flag, proceed without erroring if a repository already
  39. exists.
  40. 1.2.12
  41. * #110: Support for Borg repository initialization via borgmatic --init command-line flag.
  42. * #111: Update Borg create --filter values so a dry run lists files to back up.
  43. * #113: Update README with link to a new/forked Docker image.
  44. * Prevent deprecated --excludes command-line option from being used.
  45. * Refactor README a bit to flow better for first-time users.
  46. * Update README with a few additional borgmatic packages (Debian and Ubuntu).
  47. 1.2.11
  48. * #108: Support for Borg create --progress via borgmatic command-line flag.
  49. 1.2.10
  50. * #105: Support for Borg --chunker-params create option via "chunker_params" option in borgmatic's
  51. storage section.
  52. 1.2.9
  53. * #102: Fix for syntax error that occurred in Python 3.5 and below.
  54. * Make automated tests support running in Python 3.5.
  55. 1.2.8
  56. * #73: Enable consistency checks for only certain repositories via "check_repositories" option in
  57. borgmatic's consistency configuration. Handy for large repositories that take forever to check.
  58. * Include link to issue tracker within various command output.
  59. * Run continuous integration tests on a matrix of Python and Borg versions.
  60. 1.2.7
  61. * #98: Support for Borg --keep-secondly prune option.
  62. * Use Black code formatter and Flake8 code checker as part of running automated tests.
  63. * Add an end-to-end automated test that actually integrates with Borg.
  64. * Set up continuous integration for borgmatic automated tests on projects.evoworx.org.
  65. 1.2.6
  66. * Fix generated configuration to also include a "keep_daily" value so pruning works out of the
  67. box.
  68. 1.2.5
  69. * #57: When generating sample configuration with generate-borgmatic-config, comment out all
  70. optional configuration so as to streamline the initial configuration process.
  71. 1.2.4
  72. * Fix for archive checking traceback due to parameter mismatch.
  73. 1.2.3
  74. * #64, #90, #92: Rewrite of logging system. Now verbosity flags passed to Borg are derived from
  75. borgmatic's log level. Note that the output of borgmatic might slightly change.
  76. * Part of #80: Support for Borg create --read-special via "read_special" option in borgmatic's
  77. location configuration.
  78. * #87: Support for Borg create --checkpoint-interval via "checkpoint_interval" option in
  79. borgmatic's storage configuration.
  80. * #88: Fix declared pykwalify compatibility version range in setup.py to prevent use of ancient
  81. versions of pykwalify with large version numbers.
  82. * #89: Pass --show-rc option to Borg when at highest verbosity level.
  83. * #94: Support for Borg --json option via borgmatic command-line to --create archives.
  84. 1.2.2
  85. * #85: Fix compatibility issue between pykwalify and ruamel.yaml 0.15.52, which manifested in
  86. borgmatic as a pykwalify RuleError.
  87. 1.2.1
  88. * Skip before/after backup hooks when only doing --prune, --check, --list, and/or --info.
  89. * #71: Support for XDG_CONFIG_HOME environment variable for specifying alternate user ~/.config/
  90. path.
  91. * #74, #83: Support for Borg --json option via borgmatic command-line to --list archives or show
  92. archive --info in JSON format, ideal for programmatic consumption.
  93. * #38, #76: Upgrade ruamel.yaml compatibility version range and fix support for Python 3.7.
  94. * #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
  95. editor swap files, etc.
  96. * #81: Document user-defined hooks run before/after backup, or on error.
  97. * Add code style guidelines to the documention.
  98. 1.2.0
  99. * #61: Support for Borg --list option via borgmatic command-line to list all archives.
  100. * #61: Support for Borg --info option via borgmatic command-line to display summary information.
  101. * #62: Update README to mention other ways of installing borgmatic.
  102. * Support for Borg --prefix option for consistency checks via "prefix" option in borgmatic's
  103. consistency configuration.
  104. * Add introductory screencast link to documentation.
  105. * #59: Ignore "check_last" and consistency "prefix" when "archives" not in consistency checks.
  106. * #60: Add "Persistent" flag to systemd timer example.
  107. * #63: Support for Borg --nobsdflags option to skip recording bsdflags (e.g. NODUMP, IMMUTABLE) in
  108. archive.
  109. * #69: Support for Borg prune --umask option using value of existing "umask" option in borgmatic's
  110. storage configuration.
  111. * Update tox.ini to only assume Python 3.x instead of Python 3.4 specifically.
  112. * Add ~/.config/borgmatic/config.yaml to default configuration path probing.
  113. * Document how to develop on and contribute to borgmatic.
  114. 1.1.15
  115. * Support for Borg BORG_PASSCOMMAND environment variable to read a password from an external file.
  116. * Fix for Borg create error when using borgmatic's --dry-run and --verbosity options together.
  117. Work-around for behavior introduced in Borg 1.1.3: https://github.com/borgbackup/borg/issues/3298
  118. * #55: Fix for missing tags/releases on Gitea and GitHub project hosting.
  119. * #56: Support for Borg --lock-wait option for the maximum wait for a repository/cache lock.
  120. * #58: Support for using tilde in exclude_patterns to reference home directory.
  121. 1.1.14
  122. * #49: Fix for typo in --patterns-from option.
  123. * #47: Support for Borg --dry-run option via borgmatic command-line.
  124. 1.1.13
  125. * #54: Fix for incorrect consistency check flags passed to Borg when all three checks ("repository",
  126. "archives", and "extract") are specified in borgmatic configuration.
  127. * #48: Add "local_path" to configuration for specifying an alternative Borg executable path.
  128. * #49: Support for Borg experimental --patterns-from and --patterns options for specifying mixed
  129. includes/excludes.
  130. * Moved issue tracker from Taiga to integrated Gitea tracker at
  131. https://projects.torsion.org/witten/borgmatic/issues
  132. 1.1.12
  133. * #46: Declare dependency on pykwalify 1.6 or above, as older versions yield "Unknown key: version"
  134. rule errors.
  135. * Support for Borg --keep-minutely prune option.
  136. 1.1.11
  137. * #26: Add "ssh_command" to configuration for specifying a custom SSH command or options.
  138. * Fix for incorrect /etc/borgmatic.d/ configuration path probing on macOS. This problem manifested
  139. as an error on startup: "[Errno 2] No such file or directory: '/etc/borgmatic.d'".
  140. 1.1.10
  141. * Pass several Unix signals through to child processes like Borg. This means that Borg now properly
  142. shuts down if borgmatic is terminated (e.g. due to a system suspend).
  143. * #30: Support for using tilde in repository paths to reference home directory.
  144. * #43: Support for Borg --files-cache option for setting the files cache operation mode.
  145. * #45: Support for Borg --remote-ratelimit option for limiting upload rate.
  146. * Log invoked Borg commands when at highest verbosity level.
  147. 1.1.9
  148. * #17, #39: Support for user-defined hooks before/after backup, or on error.
  149. * #34: Improve clarity of logging spew at high verbosity levels.
  150. * #30: Support for using tilde in source directory path to reference home directory.
  151. * Require "prefix" in retention section when "archive_name_format" is set. This is to avoid
  152. accidental pruning of archives with a different archive name format. For similar reasons, default
  153. "prefix" to "{hostname}-" if not specified.
  154. * Convert main source repository from Mercurial to Git.
  155. * Update dead links to Borg documentation.
  156. 1.1.8
  157. * #40: Fix to make /etc/borgmatic/config.yaml optional rather than required when using the default
  158. config paths.
  159. 1.1.7
  160. * #29: Add "archive_name_format" to configuration for customizing archive names.
  161. * Fix for traceback when "exclude_from" value is empty in configuration file.
  162. * When pruning, make highest verbosity level list archives kept and pruned.
  163. * Clarification of Python 3 pip usage in documentation.
  164. 1.1.6
  165. * #13, #36: Support for Borg --exclude-from, --exclude-caches, and --exclude-if-present options.
  166. 1.1.5
  167. * #35: New "extract" consistency check that performs a dry-run extraction of the most recent
  168. archive.
  169. 1.1.4
  170. * #18: Added command-line flags for performing a borgmatic run with only pruning, creating, or
  171. checking enabled. This supports use cases like running consistency checks from a different cron
  172. job with a different frequency, or running pruning with a different verbosity level.
  173. 1.1.3
  174. * #15: Support for running multiple config files in /etc/borgmatic.d/ from a single borgmatic run.
  175. * Fix for generate-borgmatic-config writing config with invalid one_file_system value.
  176. 1.1.2
  177. * #33: Fix for passing check_last as integer to subprocess when calling Borg.
  178. 1.1.1
  179. * Part of #33: Fix for upgrade-borgmatic-config converting check_last option as a string instead of
  180. an integer.
  181. * Fix for upgrade-borgmatic-config erroring when consistency checks option is not present.
  182. 1.1.0
  183. * Switched config file format to YAML. Run upgrade-borgmatic-config to upgrade.
  184. * Added generate-borgmatic-config command for initial config creation.
  185. * Dropped Python 2 support. Now Python 3 only.
  186. * #19: Fix for README mention of sample files not included in package.
  187. * #23: Sample files for triggering borgmatic from a systemd timer.
  188. * Support for backing up to multiple repositories.
  189. * To free up space, now pruning backups prior to creating a new backup.
  190. * Enabled test coverage output during tox runs.
  191. * Added logo.
  192. 1.0.3
  193. * #22: Fix for verbosity flag not actually causing verbose output.
  194. 1.0.2
  195. * #21: Fix for traceback when remote_path option is missing.
  196. 1.0.1
  197. * #20: Support for Borg's --remote-path option to use an alternate Borg
  198. executable. See sample/config.
  199. 1.0.0
  200. * Attic is no longer supported, as there hasn't been any recent development on
  201. it. Dropping Attic support will allow faster iteration on Borg-specific
  202. features. If you're still using Attic, this is a good time to switch to Borg!
  203. * Project renamed from atticmatic to borgmatic. See the borgmatic README for
  204. information on upgrading.
  205. 0.1.8
  206. * Fix for handling of spaces in source_directories which resulted in backup up everything.
  207. * Fix for broken links to Borg documentation.
  208. * At verbosity zero, suppressing Borg check stderr spew about "Checking segments".
  209. * Support for Borg --one-file-system.
  210. * Support for Borg create --umask.
  211. * Support for file globs in source_directories.
  212. 0.1.7
  213. * #12: Fixed parsing of punctuation in configuration file.
  214. * Better error message when configuration file is missing.
  215. 0.1.6
  216. * #10: New configuration option for the encryption passphrase.
  217. * #11: Support for Borg's new archive compression feature.
  218. 0.1.5
  219. * Changes to support release on PyPI. Now pip installable by name!
  220. 0.1.4
  221. * Adding test that setup.py version matches release version.
  222. 0.1.3
  223. * #2: Add support for "borg check --last N" to Borg backend.
  224. 0.1.2
  225. * As a convenience to new users, allow a missing default excludes file.
  226. * New issue tracker, linked from documentation.
  227. 0.1.1
  228. * Adding borgmatic cron example, and updating documentation to refer to it.
  229. 0.1.0
  230. * New "borgmatic" command to support Borg backup software, a fork of Attic.
  231. 0.0.7
  232. * Flag for multiple levels of verbosity: some, and lots.
  233. * Improved mocking of Python builtins in unit tests.
  234. 0.0.6
  235. * New configuration section for customizing which Attic consistency checks run, if any.
  236. 0.0.5
  237. * Fixed regression with --verbose output being buffered. This means dropping the helpful error
  238. message introduced in 0.0.4.
  239. 0.0.4
  240. * Now using tox to run tests against multiple versions of Python in one go.
  241. * Helpful error message about how to create a repository if one is missing.
  242. * Troubleshooting section with steps to deal with broken pipes.
  243. * Nosetests config file (setup.cfg) with defaults.
  244. 0.0.3
  245. * After pruning, run attic's consistency checks on all archives.
  246. * Integration tests for argument parsing.
  247. * Documentation updates about repository encryption.
  248. 0.0.2
  249. * Configuration support for additional attic prune flags: keep_within, keep_hourly, keep_yearly,
  250. and prefix.
  251. 0.0.1
  252. * Initial release.