Simple, configuration-driven backup software for servers and workstations
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.

402 lines
17 KiB

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