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.
 
 

313 lines
13 KiB

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