v0.7.0 update docs

.changes/unreleased/Added-20250111-211546.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: '[feat]: package `packageOperation` option `checkVersion` implemented'
-time: 2025-01-11T21:15:46.207199643-06:00

.changes/unreleased/Added-20250111-211813.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: user management added - see docs
-time: 2025-01-11T21:18:13.182822019-06:00

.changes/unreleased/Added-20250113-231248.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: Support for remote config sources. Only config file and list can be used for now.
-time: 2025-01-13T23:12:48.383700682-06:00

.changes/unreleased/Added-20250128-153524.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: Cache functionality - still a WIP
-time: 2025-01-28T15:35:24.512485671-06:00

.changes/unreleased/Added-20250207-212429.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: Flag `--s3-endpoint` for config file fetching from S3
-time: 2025-02-07T21:24:29.596055611-06:00

.changes/unreleased/Changed-20250113-231007.yaml

@@ -1,3 +0,0 @@
-kind: Changed
-body: Internal refactoring of config setup
-time: 2025-01-13T23:10:07.215735108-06:00

.changes/unreleased/Changed-20250113-231622.yaml

@@ -1,3 +0,0 @@
-kind: Changed
-body: Formatting and sending for notifications
-time: 2025-01-13T23:16:22.260458782-06:00

.changes/unreleased/Changed-20250128-154204.yaml

@@ -1,3 +0,0 @@
-kind: Changed
-body: "name of `configfetcher` to `remotefetcher`"
-time: 2025-01-28T15:42:04.282668058-06:00

.changes/unreleased/Changed-20250208-151508.yaml

@@ -1,3 +0,0 @@
-kind: Changed
-body: Flags that took comma-separated lists now have to be passed multiple times for each argument.
-time: 2025-02-08T15:15:08.457086102-06:00

.changes/unreleased/Fixed-20250128-153806.yaml

@@ -1,3 +0,0 @@
-kind: Fixed
-body: Parsing of remote URLs when determining list config file path
-time: 2025-01-28T15:38:06.957506929-06:00

.changes/unreleased/Fixed-20250202-194523.yaml

@@ -1,3 +0,0 @@
-kind: Fixed
-body: Incorrect error notification template value
-time: 2025-02-02T19:45:23.872797604-06:00

.changes/v0.7.0.md

@@ -0,0 +1,16 @@
+## v0.7.0 - 2025-02-11
+### Added
+* [feat]: package `packageOperation` option `checkVersion` implemented
+* user management added - see docs
+* Support for remote config sources. Only config file and list can be used for now.
+* Cache functionality - still a WIP
+* Flag `--s3-endpoint` for config file fetching from S3
+### Changed
+* Internal refactoring of config setup
+* Formatting and sending for notifications
+* name of `configfetcher` to `remotefetcher`
+* Flags that took comma-separated lists now have to be passed multiple times for each argument.
+* Hosts passed to `exec host` now checked against default SSH config files
+### Fixed
+* Parsing of remote URLs when determining list config file path
+* Incorrect error notification template value

.goreleaser/gitea.yml

@@ -16,7 +16,7 @@ builds:
       - arm64
 
 archives:
-  - format: tar.gz
+  - formats: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
     name_template: >-
       {{ .ProjectName }}_{{ .Version }}_
@@ -28,7 +28,7 @@ archives:
     # use zip for windows archives
     format_overrides:
     - goos: windows
-      format: zip
+      formats: zip
 checksum:
   name_template: 'checksums.txt'
 snapshot:

.goreleaser/github.yml

@@ -17,7 +17,7 @@ builds:
       - arm64
 
 archives:
-  - format: tar.gz
+  - formats: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
     name_template: >-
       {{ .ProjectName }}_{{ .Version }}_
@@ -29,7 +29,7 @@ archives:
     # use zip for windows archives
     format_overrides:
     - goos: windows
-      format: zip
+      formats: zip
 checksum:
   name_template: 'checksums.txt'
 snapshot:

CHANGELOG.md

@@ -6,10 +6,26 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
 
+## v0.7.0 - 2025-02-11
+### Added
+* [feat]: package `packageOperation` option `checkVersion` implemented
+* user management added - see docs
+* Support for remote config sources. Only config file and list can be used for now.
+* Cache functionality - still a WIP
+* Flag `--s3-endpoint` for config file fetching from S3
+### Changed
+* Internal refactoring of config setup
+* Formatting and sending for notifications
+* name of `configfetcher` to `remotefetcher`
+* Flags that took comma-separated lists now have to be passed multiple times for each argument.
+* Hosts passed to `exec host` now checked against default SSH config files
+### Fixed
+* Parsing of remote URLs when determining list config file path
+* Incorrect error notification template value
+
 ## v0.6.1 - 2025-01-04
 ### Fixed
 * When running a list, hooks now run explicitly after the command executes. Fixed panic due to improper logic.
-
 ## v0.6.0 - 2025-01-04
 ### Added
 * Command Type Package - allows one to perform package operations [docs](https://backy.cybershell.xyz/config/packages/)

cmd/host.go

@@ -15,14 +15,16 @@ var (
 	}
 )
 
-// Holds command list to run
+// Holds list of hosts to run commands on
 var hostsList []string
+
+// Holds command list to run
 var cmdList []string
 
 func init() {
 
-	hostExecCommand.Flags().StringArrayVarP(&hostsList, "hosts", "m", nil, "Accepts space-separated names of hosts.")
-	hostExecCommand.Flags().StringArrayVarP(&cmdList, "command", "c", nil, "Accepts space-separated names of commands.")
+	hostExecCommand.Flags().StringArrayVarP(&hostsList, "hosts", "m", nil, "Accepts space-separated names of hosts. Specify multiple times for multiple hosts.")
+	hostExecCommand.Flags().StringArrayVarP(&cmdList, "command", "c", nil, "Accepts space-separated names of commands. Specify multiple times for multiple commands.")
 	parseS3Config()
 
 }
@@ -42,14 +44,19 @@ func Host(cmd *cobra.Command, args []string) {
 	if hostsList == nil {
 		logging.ExitWithMSG("error: hosts must be specified", 1, &backyConfOpts.Logger)
 	}
-	// host is only checked when we read the SSH File
-	// so a check may not be needed here
-	// but we can check if the host is in the config file
+
 	for _, h := range hostsList {
+		// check if h exists in the config file
 		_, hostFound := backyConfOpts.Hosts[h]
 		if !hostFound {
+			// check if h exists in the SSH config file
+			hostFoundInConfig, s := backy.CheckIfHostHasHostName(h)
+			if !hostFoundInConfig {
 				logging.ExitWithMSG("host "+h+" not found", 1, &backyConfOpts.Logger)
 			}
+			// create host with hostname and host
+			backyConfOpts.Hosts[h] = &backy.Host{Host: h, HostName: s}
+		}
 	}
 	if cmdList == nil {
 		logging.ExitWithMSG("error: commands must be specified", 1, &backyConfOpts.Logger)

cmd/version.go

@@ -7,7 +7,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-const versionStr = "0.6.1"
+const versionStr = "0.7.0"
 
 var (
 	versionCmd = &cobra.Command{

docs/content/cli/_index.md

@@ -14,7 +14,7 @@ Usage:
   backy [command]
 
 Available Commands:
-  backup      Runs commands defined in config file.
+  backup      Runs commands defined in config file. Use -l flag multiple times to run multiple lists.
   completion  Generate the autocompletion script for the specified shell
   cron        Starts a scheduler that runs lists defined in config file.
   exec        Runs commands defined in config file in order given.
@@ -25,6 +25,8 @@ Available Commands:
 Flags:
   -f, --config string        config file to read from
   -h, --help                 help for backy
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 
 Use "backy [command] --help" for more information about a command.
@@ -39,14 +41,16 @@ Backup executes commands defined in config file.
 Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
 
 Usage:
-  backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]
+  backy backup [--lists=list1 --lists list2 ... | -l list1 -l list2 ...] [flags]
 
 Flags:
   -h, --help                help for backup
-  -l, --lists strings   Accepts comma-separated names of command lists to execute.
+  -l, --lists stringArray   Accepts comma-separated names of command lists to execute.
 
 Global Flags:
   -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -63,6 +67,8 @@ Flags:
 
 Global Flags:
   -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -83,6 +89,8 @@ Flags:
 
 Global Flags:
   -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 
 Use "backy exec [command] --help" for more information about a command.
@@ -95,15 +103,17 @@ Host executes specified commands on the hosts defined in config file.
 Use the --commands or -c flag to choose the commands.
 
 Usage:
-  backy exec host [--commands=command1,command2, ... | -c command1,command2, ...] [--hosts=host1,hosts2, ... | -m host1,host2, ...]  [flags]
+  backy exec host [--command=command1 --command=command2 ... | -c command1 -c command2 ...] [--hosts=host1 --hosts=hosts2 ... | -m host1 -m host2 ...]  [flags]
 
 Flags:
-  -c, --commands strings   Accepts comma-separated names of commands.
+  -c, --command stringArray   Accepts space-separated names of commands. Specify multiple times for multiple commands.
   -h, --help                  help for host
-  -m, --hosts strings      Accepts comma-separated names of hosts.
+  -m, --hosts stringArray     Accepts space-separated names of hosts. Specify multiple times for multiple hosts.
 
 Global Flags:
   -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -122,6 +132,8 @@ Flags:
 
 Global Flags:
   -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```
 
@@ -141,5 +153,7 @@ Flags:
 
 Global Flags:
   -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
   -v, --verbose              Sets verbose level
 ```

pkg/backy/backy.go

@@ -34,15 +34,17 @@ var Sprintf = fmt.Sprintf
 func (command *Command) RunCmd(cmdCtxLogger zerolog.Logger, opts *ConfigOpts) ([]string, error) {
 
 	var (
-		outputArr     []string
-		ArgsStr       string
+		ArgsStr       string // concatenating the arguments
 		cmdOutBuf     bytes.Buffer
 		cmdOutWriters io.Writer
+		errSSH        error
 
 		envVars = environmentVars{
 			file: command.Env,
 			env:  command.Environment,
 		}
+
+		outputArr []string // holds the output strings returned by processes
 	)
 
 	// Get the command type
@@ -53,13 +55,13 @@ func (command *Command) RunCmd(cmdCtxLogger zerolog.Logger, opts *ConfigOpts) ([
 		ArgsStr += fmt.Sprintf(" %s", v)
 	}
 
+	// print the user's password if it is updated
 	if command.Type == "user" {
 		if command.UserOperation == "password" {
 			cmdCtxLogger.Info().Str("password", command.UserPassword).Msg("user password to be updated")
 		}
 	}
 
-	var errSSH error
 	// is host defined
 	if command.Host != nil {
 		outputArr, errSSH = command.RunCmdSSH(cmdCtxLogger, opts)

pkg/backy/ssh.go

@@ -757,3 +757,12 @@ func (h *Host) DetectOS(opts *ConfigOpts) (string, error) {
 	osName := string(output)
 	return osName, nil
 }
+
+func CheckIfHostHasHostName(host string) (bool, string) {
+	HostName, err := ssh_config.DefaultUserSettings.GetStrict(host, "HostName")
+	if err != nil {
+		return false, ""
+	}
+	println(HostName)
+	return HostName != "", HostName
+}

release

@@ -1,6 +1,13 @@
 #!/bin/bash
-# export GORELEASER_CURRENT_TAG="$(go run backy.go version -V)"
-git tag "$(go run backy.go version -V)"
+set -eou pipefail
+export CURRENT_TAG="$(go run backy.go version -V)"
+goreleaser -f .goreleaser/github.yml check
+goreleaser -f .goreleaser/gitea.yml check
+changie batch $CURRENT_TAG
+changie merge
+git add .changes/
+git commit -am "$CURRENT_TAG"
+git tag "$CURRENT_TAG"
 git push all
 git push all --tags
 # goreleaser release -f .goreleaser/gitea.yml --clean --release-notes=".changes/$(go run backy.go version -V).md"