v0.30.0

🌱 Spring release 🌸

This release introduces features and fixes for profile scheduling.

⚠️ Breaking change

Until this release, the user scheduling permission was broken. With systemd or the default macOS scheduler, the permission functioned as user_logged_on, running the profile only when the user was logged in.

This issue is now fixed for new schedules.

To update existing schedules, run unschedule and then schedule again.

For systemd, resticprofile requires root privileges (via sudo) to schedule with user permission, as it now uses a system unit running as the user.

Scheduler

Scheduling has been significantly improved with the ability to read existing schedules. The status and unschedule commands now detect any resticprofile schedules from the selected configuration file, even if the profile is no longer present.

Due to recent error reports, Windows Task Scheduler integration has been completely rewritten to use the schtasks CLI tool.

Other

• Fixed issue with non-existent battery reported on recent Mac desktop hardware.
• Added support for Restic 0.18.
• Included pre-built binary for Windows on ARM64.
• Upload Resticprofile container to GitHub Container Registry.

Changelog

• f14094b Correct configuration search paths on Windows (#478)
• 1b05c7a Create FUNDING.yml
• b6b8285 Documentation versioning (#464)
• edc1292 Run tests on read only source dir (#461)
• ae073ae Schedule user logged in (#470)
• 8d8a0da Scheduling improvements (#425)
• e490c42 Set schedule permissions (#476)
• 07df141 Upload to Github Container Registry (#479)
• 4103971 Use schtasks.exe CLI to schedule jobs on Windows (#459)
• ae38db9 add microarchitecture to version command (#466)
• 87cfd5d add other restic exit codes
• ac3b810 chore: add pre-built binary for windows arm64
• edbea57 chore: add support for restic 0.18
• c5a5dfa don't include systemd dependencies on macos & windows
• af9ab7f fix for macOs ghost battery (#468)
• 6c9b3cd remove devcontainer config
• b867b01 replace experimental maps package with standard library (#467)

v0.29.1

❄️ Small maintenance release ☃️

Not much going on in this maintenance release while I'm still working on a big refactoring of the scheduling for the next release.

• logrotate package added to the Docker image
• upgrade dependencies to fix security vulnerabilities

Changelog

• e2297a6 add logrotate to docker image #440
• 37c9aef upgrade package - CVE-2024-45337
• 467b82e upgrade packages

v0.29.0

🧙🏻‍♀️ Halloween edition 🎃

• Finally a long standing bug was fixed in this version: use proper nice and ionice values on systemd scheduled tasks.
• Also the last chunk of work for the configuration v2: we can now schedule groups!
• Improvement on the JSON schema: a single URL can be used for v1 and v2 configuration
• Another long standing bug on Windows: escape configuration file path on scheduled tasks

Changelog

• fb6c7a2 Escape config file name in schedule parameters (#420)
• 1d3ec32 Fix scheduling arguments (#423)
• 62c5c64 Global json schema (auto versioning) (#412)
• 2a34ea7 Group schedule (#418)
• 830d0fd Setup systemd priority (#409)
• 62f3118 doc: upgrade hugo theme
• da03de7 fix deprecated option in goreleaser config

v0.28.1

🍂 Autumn bug fixing 🍁

• fix JSON schema for TOML files that stopped working some time ago (when using Even Better TOML extension on VSCode)
• [configuration v2] fix regression bug where profile groups were stopping after an error when the continue-on-error flag was set

Changelog

• 57d1439 Fix for continue-on-error broken in 0.26.0 (#407)
• ccccfa2 Linters (#397)
• 249fd41 add base url on json schema (#408)
• b254503 add misspell linter
• 7dcb41b fix bullet points from restic man (#398)
• 4181d9e fix overflow integer conversion lint warning from gosec (#399)
• 2231793 generate JSON schema for restic 0.17
• 0ad1b68 prepare next release
• 3612b51 use goreleaser v2

v0.28.0

🌞 Sunny Summer Edition 🌻

Two big things in this release:

• support for all the new commands and flags of restic 0.17
• experimental support for environment variables in configuration flags

Example of using environment variables in configuration:

check-repo-profile:
    inherit: default

    run-before:
        - "echo DOW=`date +\"%u\"` >> {{ env }}"

    check:
        read-data-subset: "$DOW/7"

Changelog

• 3b42e4a Add contributed docs for protected configuration on Windows (#394)
• 1e80d02 Restic 0.17 (#396)
• eb8c721 build with go 1.23
• 1df3711 convert priority value to lowercase
• d74c521 fix panic when sending on closed handler
• 49add79 refactoring of arguments generation (#387)
• cff446b upgrade packages

v0.27.1

🌦️ Rainy Summer Edition ☔

Fix of a regression bug preventing resticprofile from sending logs to a temporary session log file (prefixed with temp:/t/)
Thanks @iluvatyr for the quick bug report 👍🏻

Changelog

• a615444 fix creation of mock binaries during unit tests (#375)
• c9f87ec fix documentation for release
• eb13003 fix regression with temporary log file (#386)
• abf35a7 prepare next release
• 854f6c9 refactor unit tests on package lock (#374)
• ffffabf remove flaky test
• 5cfdca2 remove goarm linked to the internal variable of runtime go1.23 will apparently forbid the use of linkname to the standard library

v0.27.0

🌻 Summer release 🌞

Summer is here in the Northern Hemisphere! A new release is here too! 🎉

A lot of goodies in this release:

new run-schedule command

It's more a behind the scene feature: you no longer need to re-schedule your targets after you changed the configuration. The generated schedule command line is now using this new run-schedule command that reads all the newest bits from the configuration.

You might want to unschedule and schedule all your profiles one last time to replace the existing command line using the new run-schedule command.

More information: https://creativeprojects.github.io/resticprofile/schedules/commands/index.html#run-schedule-command

direct support for crontab files

Previously resticprofile was using the crontab tool to read and write crond schedules. Now you can directly setup a crontab file no matter which tool is going to consume it.

More information: https://creativeprojects.github.io/resticprofile/schedules/index.html

keep content of configuration variables between commands

This was a big issue for some time. The wait is over! You can now set a configuration variable anywhere in a script and use its value later.

More information: https://creativeprojects.github.io/resticprofile/configuration/run_hooks/index.html#passing-environment-variables

"RESTICPROFILE_{FLAGNAME}" env vars

All cli flags can now be set using environment variables.

More information: #334

allow controlling command output redirection

Allow redirection of the console messages to a log file or to syslog.

More information: #343

Add "--stderr" to redirect console to stderr (for "cat" and "dump")

More information: #353

Add option to set working directory for restic backup

More information: #354

many bug fixes!

Changelog

• 1bbac2a Add "--stderr" to redirect console to stderr (for "cat" and "dump") (#353)
• 0598026 Add documentation on how to ingest resticprofile stats into telegraf (#366)
• f9b5dac Add option to set working directory for restic backup (#354)
• 00360a2 Fix group priority (#339)
• a05ad39 Relative source followup: Evaluate symlinks (#355)
• 56f20af Squashed commit of the following: (#259)
• 6b00c2c add "profile" flag as an alias for "name" (#357)
• 6da0317 also search configuration from ~/.config/resticprofile on macOS (#370)
• 5739b13 crond: add support for crontab file only (on any OS) (#289)
• 9719411 don't replace header value in stringifyHeaders (#327)
• 2a7d5fc drop-ins: move systemd drop-ins into unified schedule struct (#341)
• 7e03741 drop-ins: transparent timer drop-in support (#340)
• 9b2bd8c env-file: Implement dotenv and {{env}} support (#323)
• 16f5dc5 fix remaining unit tests failing in Windows (#360)
• 3b8613e fixed link to config reference / global section (#349)
• 5fad1cb flags: added "RESTICPROFILE_{FLAGNAME}" env vars (#335)
• 85d5afc log: allow controlling command output redirection (#343)
• e5b17d3 restic: use repository-file if the repo flag contains a password (#336)
• 4255868 schedule: added unified schedule config struct (#333)
• 667180e syslog: local syslog and stdout redirection (#344)
• e93874d build with go 1.22 and macOs arm64 (#317)
• e6eed3d update test to pass on Windows 11 (#359)
• 655e9c5 upgrade packages (CVE-2024-24786) (#347)
• 08a01c4 upgrade packages (CVE-2024-6104)

v0.26.0

🦆 Second time lucky February release 🚀

🆕 A lot of pre-built binaries have been added on this release. This is to align with the list of pre-built binaries provided by restic

Otherwise this is mostly a maintenance release with a few fixes:

• fixes multiple backup profiles exporting prometheus files to node_exporter
• fix missing fields in the show command
• weekly docker image build (rebuilt under the same version tag, and as latest)
• restrict the copy command to a list of snapshots in the configuration

Changelog

• 2ab1f3a Add pre-built binary targets to release pipeline (#324)
• 233e4b8 Add prometheus label to build info (#319)
• b1b03db Change priority warning message (#310)
• 9eba431 Fix missing fields in show command (#315)
• a9273f8 Merge pull request #312 from creativeprojects/nightly
• 15004f9 Restrict copy command to a list of snapshots (#291)
• 1c076dc add separate goreleaser config for rebuilding the docker image only (#309)
• bbb3760 add snapshot build to docker hub
• 8aebd28 publish docker images and manifest manually (#313)

v0.25.0

💖 February release 💝

⚠️ Potential breaking change

The prometheus library used to send metrics to the proxy using protobuf.
By default it's now using the more widely used text format.

If you have any issue sending metrics to your proxy, you can revert to the previous behaviour by adding this option to your profile (it's not a global option)

my_profile:
  prometheus-push-format: protobuf

More information about the different formats: https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats

New in this version

• fix for CVE-2023-48795
• new option prometheus-push-format with values text or protobuf (#281)
• new option to set log output in global section (#277)
• more control over the default systemd service files (#267)
• and bug fixes!

Thanks to all our contributors for the good work!

Changelog

• 765c2af Add prometheus-push-format to allow selecting text format (#281)
• ae9554a Pass context to own commands and profile runner (#280)
• fccc05b Remove rclone binary in make clean target (#283)
• 0871d28 Trying new configuration for CodeQL (#306)
• 1317f60 Upgrade packages (#307)
• 63f8faf chore: prep next release & allow deployment to fail on PR
• 3d72803 chore: various fixes (#285)
• 952380f doc: add information about windows path in variables
• f346571 doc: add various missing information (#278)
• 1b3292c logging: allow to setup default log output in global (#277)
• 99484bf macOS: create LaunchAgents folder if it doesn't exist
• 37dcf84 profile: support source with "-" (dash) prefix (#276)
• a1b7840 systemd drop-ins support, option to wait for network-online.target (#267)

v0.24.0

🎃 October release 👻

• upgrade dependencies to fix CVE-2023-3978, CVE-2023-39325 and CVE-2023-44487
• fix the broken documentation (some tabs were not accessible)
• can now stop the wait for a lock (restic or resticprofile lock). Before the fix the CTRL-C or other signal was ignored until the lock was acquired or timed out.
• resticprofile is now available on scoop! thanks @hgraeber
• detect if the host is running on battery and cancel an action depending on how much battery is left - see schedule section
• bug fixes (see changelog)

Changelog

• ac99302 Allow to interrupt the wait for a lock (#249)
• b08ac73 Detect if running on battery (#235)
• 1e6d07a Docs for installation from scoop (#268)
• 0d73c2b Fix doc shortcodes (#271)
• f5e751c Template: Reduce log level for Getwd() failures (#251)
• e20973e systemd: prevent paging in systemd schedules (#270)
• bcfaaa7 upgrade packages - CVE-2023-3978 - CVE-2023-39325 - CVE-2023-44487