cupcakearmy/autorestic
1
0
Fork 0
mirror of https://github.com/cupcakearmy/autorestic.git synced 2024-12-22 08:16:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(lockfile) change flag to --lockfile

Browse Source 
This is more consistent with the `lockfile` config option
This commit is contained in:
Boris Bera 2024-12-01 14:53:25 -05:00
parent de0862a3dd
commit 59b2393127
No known key found for this signature in database
GPG Key ID: 97AF3BB8EEBDF180
6 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/root.go
View File

@ -41,7 +41,7 @@ func init() {
rootCmd.PersistentFlags().BoolVarP(&flags.VERBOSE, "verbose", "v", false, "verbose mode")
rootCmd.PersistentFlags().StringVar(&flags.RESTIC_BIN, "restic-bin", "restic", "specify custom restic binary")
rootCmd.PersistentFlags().StringVar(&flags.DOCKER_IMAGE, "docker-image", "cupcakearmy/autorestic:"+internal.VERSION, "specify a custom docker image")
rootCmd.PersistentFlags().StringVar(&flags.LOCKFILE_PATH, "lockfile-path", "", "specify a custom path for the lockfile (defaults to .autorestic.lock.yml next to the loaded autorestic config file)")
rootCmd.PersistentFlags().StringVar(&flags.LOCKFILE, "lockfile", "", "specify a custom path for the lockfile (defaults to .autorestic.lock.yml next to the loaded autorestic config file)")
cobra.OnInitialize(initConfig)
}

4
docs/pages/cli/general.md
View File

@ -35,10 +35,10 @@ With `--restic-bin` you can specify to run a specific restic binary. This can be
autorestic --restic-bin /some/path/to/my/custom/restic/binary
```
## `--lockfile-path`
## `--lockfile`
Specify the path for the [lockfile](../lockfile.md) used by `autorestic`. If omitted, this will default to `.autorestic.lock.yml` next to the loaded config file.
```bash
autorestic --lockfile-path /path/to/my/.autorestic.lock.yml
autorestic --lockfile /path/to/my/.autorestic.lock.yml
```

2
docs/pages/lockfile.md
View File

@ -8,7 +8,7 @@ By default, the lockfile is stored next to your [configuration file](./config.md
The path to the lockfile can be customized if need be. This can be done is a few ways:
1. Using the `--lockfile-path ...` command line flag
1. Using the `--lockfile ...` command line flag
1. Setting `lockfile: ...` in the configuration file
Note that `autorestic` will check for a customized lockfile path in the order listed above. This means that if you specify a lockfile path in multiple places, the method that's higher in the list will win.

12
internal/flags/flags.go
View File

@ -1,10 +1,10 @@
package flags
var (
CI bool = false
VERBOSE bool = false
CRON_LEAN bool = false
RESTIC_BIN string
DOCKER_IMAGE string
LOCKFILE_PATH string
CI bool = false
VERBOSE bool = false
CRON_LEAN bool = false
RESTIC_BIN string
DOCKER_IMAGE string
LOCKFILE string
)

10
internal/lock.go
View File

@ -20,14 +20,14 @@ const (
)
// getLockfilePath returns the path to the lockfile. The path for the lockfile
// can be sources from multiple places If flags.LOCKFILE_PATH is set, its value
// is used; if the config has the `lockfile` option set, its value is used;
// can be sources from multiple places If flags.LOCKFILE is set, its value is
// used; if the config has the `lockfile` option set, its value is used;
// otherwise the path is generated relative to the config file.
func getLockfilePath() string {
if flags.LOCKFILE_PATH != "" {
abs, err := filepath.Abs(flags.LOCKFILE_PATH)
if flags.LOCKFILE != "" {
abs, err := filepath.Abs(flags.LOCKFILE)
if err != nil {
return flags.LOCKFILE_PATH
return flags.LOCKFILE
}
return abs
}

4
internal/lock_test.go
View File

@ -17,7 +17,7 @@ import (
func setup(t *testing.T) {
t.Helper()
cleanup := func() {
flags.LOCKFILE_PATH = ""
flags.LOCKFILE = ""
config = nil
once = sync.Once{}
viper.Reset()
@ -62,7 +62,7 @@ func TestGetLockfilePath(t *testing.T) {
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
setup(t)
flags.LOCKFILE_PATH = testCase.flag
flags.LOCKFILE = testCase.flag
if testCase.config != "" {
viper.Set("lockfile", testCase.config)
err := viper.WriteConfig()