Andrew Woodlee
d120c2ca8f
All checks were successful
ci/woodpecker/push/publish-docs Pipeline was successful
55 lines
2.5 KiB
Markdown
55 lines
2.5 KiB
Markdown
# Changelog
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
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.
|
|
|
|
## v0.3.0 - 2023-01-07
|
|
### Added
|
|
* Getting environment variables and passwords from Vault (not tested yet)
|
|
* Vault configuration to config (not tested yet)
|
|
* Ability to run scripts from file on local machine on the remote host
|
|
* Ability to get ouput in the notification of a list for individual commands or all commands
|
|
### Changed
|
|
* Make SSH connections close after all commands have been run; reuse previous connections if needed
|
|
|
|
## 0.2.4 - 2023-02-18
|
|
### Added
|
|
* Notifications now display errors and the output of the failed command.
|
|
* CI configs for GitHub and Woodpecker
|
|
* Added `version` subcommand
|
|
### Changed
|
|
* Console logging can be disabled by setting `console-disabled` in the `logging` object
|
|
## Fixed
|
|
* If Host was not defined for an incomplete `hosts` object, any commands would fail as they could not look up the values in the SSH config files.
|