update CI config

This reverts commit b7d1be495e.

.changes/unreleased/Added-20240828-142730.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: Lists config can now go in a file. See docs for more information.
-time: 2024-08-28T14:27:30.427754114-05:00

.changes/unreleased/Added-20241008-223733.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: 'new commands.[name].type: script. Works just like scriptFile, but can take arguments.'
-time: 2024-10-08T22:37:33.664140846-05:00

.changes/unreleased/Added-20241114-210148.yaml

@@ -1,3 +0,0 @@
-kind: Added
-body: Hooks for Commands.[name]. Error, success, and final. [#12]
-time: 2024-11-14T21:01:48.823426401-06:00

.changes/unreleased/Changed-20240514-195817.yaml

@@ -1,3 +0,0 @@
-kind: Changed
-body: GetKnownHosts is now a method of Host
-time: 2024-05-14T19:58:17.516072381-05:00

.changes/unreleased/Fixed-20241114-211306.yaml

@@ -1,3 +0,0 @@
-kind: Fixed
-body: make command logger be used for errors, not just when running the command
-time: 2024-11-14T21:13:06.404134926-06:00

.changes/v0.5.0.md

@@ -0,0 +1,9 @@
+## v0.5.0 - 2024-11-19
+### Added
+* Lists can now go in a file. See docs for more information.
+* commands.[name].type: script now opens `scriptEnvFile`.
+* Hooks for Commands.[name]. Error, success, and final. [#12]
+### Changed
+* GetKnownHosts is now a method of Host
+### Fixed
+* make command logger be used for errors, not just when running the command

.goreleaser/gitea.yml

@@ -1,3 +1,4 @@
+version: 2
 before:
   hooks:
     # You may remove this if you don't use go modules.
@@ -31,9 +32,9 @@ archives:
 checksum:
   name_template: 'checksums.txt'
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
 changelog:
-  skip: false
+  disable: false
 
 gitea_urls:
   api: https://git.andrewnw.xyz/api/v1

.goreleaser/github.yml

@@ -1,5 +1,6 @@
 # This is an example .goreleaser.yml file with some sensible defaults.
 # Make sure to check the documentation at https://goreleaser.com
+version: 2
 before:
   hooks:
     # You may remove this if you don't use go modules.
@@ -32,7 +33,7 @@ archives:
 checksum:
   name_template: 'checksums.txt'
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
 changelog:
   sort: asc
   filters:

.woodpecker/go-lint.yml

@@ -7,4 +7,8 @@ steps:
   release:
     image: golangci/golangci-lint:v1.53.3
     commands:
-      - golangci-lint run -v --timeout 5m
+      - golangci-lint run -v --timeout 5m
+
+when:
+  - event: push
+    branch: develop

.woodpecker/publish-docs.yml

@@ -5,6 +5,10 @@ steps:
       - git submodule foreach 'git fetch origin; git checkout $(git describe --tags `git rev-list --tags --max-count=1`);'
       - cd docs
       - hugo
+    when:
+      - event: push
+        branch: master
+        path: "docs/*"
 
   deploy:
     image: codingkoopa/git-rsync-openssh
@@ -23,8 +27,7 @@ steps:
       - rsync -atv --delete --progress vangen/ backy@backy.cybershell.xyz:vangen-go
     secrets: [ ssh_host_key, ssh_deploy_key, ssh_passphrase ]
 
-
+    when:
-when:
+      - event: push
-  - event: push
+        branch: master
-    branch: master
+        path: "docs/*"
-    path: "docs/*"

CHANGELOG.md

@@ -6,6 +6,30 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
 
+## v0.5.0 - 2024-11-19
+### Added
+* Lists can now go in a file. See docs for more information.
+* commands.[name].type: script now opens `scriptEnvFile`.
+* Hooks for Commands.[name]. Error, success, and final. [#12]
+### Changed
+* GetKnownHosts is now a method of Host
+### Fixed
+* make command logger be used for errors, not just when running the command
+
+## v0.4.0 - 2023-09-08
+
+### Added
+
+* Added `scriptEnvFile` to command object that allows one to specify an environment file (or any file really) when a `scriptFile` is run. Inspired by the practice of keeping environment variables and scripts or commands seperate.
+* Basis for listing commands
+
+### Changed
+
+* BREAKING: Notifications object now takes the form of service.id, where service can be "mail" or "matrix" and id is a unique id for the service.
+* BREAKING: Since the change to the notifications object, cmd-lists' inner map key 'notifications' must be of the form service.id. id must be defined for that service. See notifications docs for aviliable services.
+* Config parser is now the simpler Koanf - Keys are now case-sensitive
+* Log size limited to 50 Mb
+
 ## v0.3.1 - 2023-07-20
 ### Changed
 * If an SSH session failed to be created, the command would fail. This would be caused when restarting the SSH host. The SSH connection is attempted to be created again. If successful, the command is executed normally.

cmd/version.go

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

docs/.gitignore

@@ -0,0 +1,2 @@
+public/
+resources/_gen

docs/content/_index.md

@@ -7,6 +7,8 @@ Backy is a tool for automating data backup and remote command execution. It can
 
 Why the name Backy? Because I wanted an app for backups.
 
+View the [changelog here](https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/CHANGELOG.md).
+
 {{% notice tip %}}
 Feel free to open a [PR](https://git.andrewnw.xyz/CyberShell/backy/pulls), raise an [issue](https://git.andrewnw.xyz/CyberShell/backy/issues "Open a Gitea Issue")(s), or request new feature(s).
 {{% /notice %}}

docs/content/cli/_index.md

@@ -110,6 +110,7 @@ Usage:
   backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags]
 
 Flags:
+  -c, --cmds strings    Accepts comma-separated names of commands to list.
   -h, --help            help for list
   -l, --lists strings   Accepts comma-separated names of command lists to list.
 

docs/content/config/_index.md

@@ -12,10 +12,10 @@ To use a specific file:
 
 If you leave the config path blank, the following paths will be searched in order:
 
-- `./backy.yml`
+1. `./backy.yml`
-- `./backy.yaml`
+2. `./backy.yaml`
-- `~/.config/backy.yml`
+3. `~/.config/backy.yml`
-- `~/.config/backy.yaml`
+4. `~/.config/backy.yaml`
 
 Create a file at `~/.config/backy.yml`.
 

docs/content/config/command-lists.md

@@ -9,6 +9,11 @@ Command lists are for executing commands in sequence and getting notifications f
 
 The top-level object key can be anything you want but not the same as another.
 
+Lists can go in a separate file. Command lists should be in a separate file if:
+
+1. key 'cmd-lists.file' is found
+2. hosts.yml or hosts.yaml is found in the same directory as the backy config file
+
 ```yaml
   test2:
     name: test2
@@ -51,7 +56,7 @@ An array of notification IDs to use on success and failure. Must match any of th
 
 ### Name
 
-Name is optional for logging. If name is not defined, name will be the object's map key.
+Name is optional. If name is not defined, name will be the object's map key.
 
 ### Cron mode
 

docs/content/config/commands.md

@@ -19,7 +19,14 @@ commands:
       - down
     # if host is not defined, command will be run locally
     # The host has to be defined in either the config file or the SSH Config files
-    host: some-host 
+    host: some-host
+    hooks
+      error:
+        - some-other-command-when-failing
+      success:
+        - success-command
+      final:
+        - final-command
   backup-docker-container-script:
     cmd: /path/to/local/script
     # script file is input as stdin to SSH
@@ -41,6 +48,7 @@ Values available for this section:
 | `host` | If not specified, the command will execute locally. | `string` | no |
 | `scriptEnvFile` | When type is `scriptFile`, the script is appended to this file. | `string` | no |
 | `shell` | Only applicable when host is not specified | `string` | no |
+| `hooks` | Hooks are used at the end of the individual command. Must be another command. | `[]string` | no |
 
 #### cmd
 
@@ -93,9 +101,9 @@ Make sure to escape any shell input.
 
 Path to a file.
 
-When type is `scriptFile`, the script is appended to this file.
+When type is specified, the script is appended to this file.
 
-This is useful for specifiing environment variables or other things so they don't have to be included in the script.
+This is useful for specifying environment variables or other things so they don't have to be included in the script.
 
 ### type
 
@@ -116,3 +124,23 @@ For now, the variables have to be defined in an `.env` file in the same director
 If using it with host specified, the SSH server has to be configured to accept those env variables.
 
 If the command is run locally, the OS's environment is added.
+
+### hooks
+
+Hooks are run after the command is run.
+
+Errors are run if the command errors, success if it returns no error. Final hooks are run regardless of error condition.
+
+Values for hooks are as follows:
+
+```yaml
+command:
+  hook:
+    # these commands are defined elsewhere in the file
+    error:
+      - errcommand
+    success:
+      - successcommand
+    final:
+      - donecommand
+```