diff options
| author | Shulhan <ms@kilabit.info> | 2022-07-04 12:29:57 +0700 |
|---|---|---|
| committer | Shulhan <ms@kilabit.info> | 2022-07-04 12:29:57 +0700 |
| commit | c1f1407aea33c86de00d1944510cf431dbdaea0c (patch) | |
| tree | e34c19c613a0bbc61dfc2351f50dfc4395f8831b /CHANGELOG.adoc | |
| parent | 19f8b06cb886cde04822b268e77e57d80ba6e732 (diff) | |
| download | awwan-c1f1407aea33c86de00d1944510cf431dbdaea0c.tar.xz | |
www/doc: update structure of CHANGELOG
Add anchors for each sections and update each changes list to use
description list instead of bullet list.
Diffstat (limited to 'CHANGELOG.adoc')
| -rw-r--r-- | CHANGELOG.adoc | 69 |
1 files changed, 46 insertions, 23 deletions
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index d68697e..61c1d8f 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -2,6 +2,7 @@ // SPDX-License-Identifier: GPL-3.0-or-later = Changelog for awwan +[#v0_5_0] == awwan v0.5.0 (2022-03-14) This release re-lincesing the awwan software under GPL 3.0 or later. @@ -9,20 +10,24 @@ This release re-lincesing the awwan software under GPL 3.0 or later. See https://kilabit.info/journal/2022/gpl for more information. +[#v0_4_0] == awwan 0.4.0 (2022.02.05) This release bring new command "serve" to awwan. The serve command run HTTP server that provide web-user interface to create, edit, save, and execute script. +[#v0_4_0_new_features] === New features -* all: implement HTTP API and function to Save file on web-user interface +all: implement HTTP API and function to Save file on web-user interface:: + +-- The web-user interface now have button "Save" that save the edited content of file to storage. +-- -* all: implement serve command +all: implement serve command:: + -- The serve command will run a HTTP server that provide web-user interface @@ -34,70 +39,83 @@ Currently, the web-user interface provide the following features, * Running the script on local or remote -- +[#v0_4_0_enhancements] === Enhancements -* all: make the local statement executed with "/bin/sh -c ..." +all: make the local statement executed with "/bin/sh -c ...":: + +-- By using "sh -c", the statement can contains environment variable, piping, and other shell commands that cannot be supported if executed directly using native os.Exec. +-- -* all: expand the environment on statement when executing local script +all: expand the environment on statement when executing local script:: + +-- This changes replace the string ${x} or $x in the statements with the current environment variables values. -+ + For example, statement "mkdir ${HOME}/tmp" will expand the ${HOME} to the current user home directory. +-- -* all: use native SFTP to put and get file when possible +all: use native SFTP to put and get file when possible:: + +-- Previously, the command to put and get file from remote server depends on installed scp program on the host computer. -+ + In this changes we add the SFTP client and use it as primary function to put and get file to/from remote when possible and use the scp as fallback. +-- - +[#v0_3_0] == awwan 0.3.0 (2021.06.09) -* go.mod: set the minimum Go to 1.16 and update to share module v0.25.1 +go.mod: set the minimum Go to 1.16 and update to share module v0.25.1 +[#v0_3_0_enhancements] === Enhancements -* cmd/awwan: print the awwan version on command usage output +cmd/awwan: print the awwan version on command usage output:: -* all: check and return an error if start index is out of range +all: check and return an error if start index is out of range:: -* all: log error when executing script (local or play) +all: log error when executing script (local or play):: -* all: do not load SSH config if command mode is "local" +all: do not load SSH config if command mode is "local":: + +-- If the mode is local there is no need to parse and load the SSH config, since the command to be executed will run on local machine anyway. +-- -* all: set base dir based on the first .ssh directory that we found +all: set base dir based on the first .ssh directory that we found:: + +-- Previously, the base directory is set on current working directory. This limit the way to execute awwan only from the directory that contains the .ssh directory. -+ + This changes set the environment BaseDir based on the first .ssh directory that we found from script path up to the "/". So, user can execute awwan script from any sub-directories. +-- - +[#v0_2_1] == awwan 0.2.1 (2021.01.18) Update the share modules which bring fixes to "#put" commands. - +[#v0_2_0] == awwan 0.2.0 (2020.07.05) +[#v0_2_0_new_features] === New features -* environment: export the SSH key, user, host, and port +environment: export the SSH key, user, host, and port:: + -- By knowing this values, user can use it to invoke other SSH related @@ -106,7 +124,7 @@ command, for example to copy file using `scp` scp -i {{.SSHKey}} src {{.SSHUser}}@{{.SSHHost}}:{{.SSHPort}}/dst -- -* all: add magic command "#require:" +all: add magic command "#require:":: + -- Magic word `#require:` will ensure that the next statement will always @@ -125,21 +143,25 @@ executing `awwan local script.aww 3`, will always execute line number 2 `echo a`, but not line number 5 (because its before line start 3). -- +[#v0_2_0_bug_fixes] === Bug fixes -* command: change the owner of file when doing #get! +command: change the owner of file when doing `#get!`:: + +-- In case the owner of file is not active user and it does not have read permission, the "#get!" command will fail when copying command from remote to local. +-- -* command: fix magic copy and get command on templates +command: fix magic copy and get command on templates:: +[#v0_2_0_enhancements] === Enhancements -* command: merge sequences of spaces on command into single space +command: merge sequences of spaces on command into single space:: -* command: check for single, double, or back quote on command +command: check for single, double, or back quote on command:: + -- Previously, if command contains quote like, @@ -153,6 +175,7 @@ This changes fix the parsing of command string by detecting possible quote. -- +[#v0_1_0] == awwan 0.1.0 (2020.05.30) Its better late than never. |
