Release Notes
This project uses Semantic Versioning. The format of the release notes follows Keep a Changelog.
[Unreleased]
Fixed
- Link targets are displayed as absolute paths again. This bug was introduced after switching internally from split to URIs.splitpath, which does not consider root folders (#18).
v0.1.2 - 2025-05-31
Deprecated
- Path checks in
pwd(::SFTP.Client)
are deprecated (#13). This should be done during the instantiation of theSFTP.Client
.
Fixed
- Add fallback solution to determine a
filemode
inanalyse_path
with restricted access to the parent folder (#14).
v0.1.1 - 2025-05-24
Added
- Overload Julia's
dirname
with a method forSFTP
(#9).
Deprecated
- The following methods have been deprecated to avoid type piracy (#8):
pwd(::URI)
splitdir(::URI)
basename(::URI)
- For
joinpath
, the provided method by theURIs
package is used, an internalcwd
function replacespwd
,splitdir
andbasename
will be removed without replacement.
Removed
- The
joinpath(::URI, paths::AbstractString...)
method is directly removed as it seems, previously URIs'joinpath
method was used anyway (#8).
Fixed
- Ensure all
AbstractString
paths are converted toString
in functionreaddir
for correct processing of the paths (#10).
v0.1.0 - 2025-05-18
The initial release is based on SFTPClient (v0.4.4). All changes for this released are documented in respect to this version.
Added
- Initial release with new project name SFTP.jl and new initial version v0.1.0
- Prefer
Logging
over simple print commands - Overload
stat
with simplifiedstat
method for a single path object (in contrast tostatscan
that scans the whole folder) and return anSFTP.StatStruct
- Overlaod Base functions for the file system; new methods added for:
ispath
pwd
mkdir
(previousmkdir
was renamed tomkpath
)joinpath
splitdir
basename
- Add labels for docs, CI status and Codecov in Readme
- Add workflow for compat helper
- Add changelog and automate with Changelog.jl
Changed
- Update API
- exported:
upload
,statscan
,URI
- public:
Client
,StatStruct
,download
,stat
,filemode
,ispath
,isdir
,isfile
,islink
,pwd
,cd
,mv
,rm
,mkdir
,mkpath
,readdir
,walkdir
,joinpath
,splitdir
,basename
- exported:
- Completely refactor code base, use concise variable names, format source code
- Rename
SFTPStatStruct
toStatStruct
(unexported) and refactor constructors - Rename
SFTP
toClient
(unexported) and refactor constructors - Rename
sftpstat
tostatscan
- Rename
mkdir
tomkpath
(as it has the functionality ofmkpath
, add new method formkdir
) - Update functionality of file system functions to more close resemble Julia's Base functions
- Combine
rm
/rmdir
inrm
with aforce
flag - Sort results in
readdir
,stat
,statscan
, andwalkdir
(can be switched off withsort
flag) - Introduce more checks and restrictions based on Julia's file system function/Unix functions
- Check validity of a path
- Add methods to pass a path as
String
tofilemode
and related functions instead of aStatStruct
object - Allow recursive methods, where appropriate
- Combine
- Allow upload/download of directories
- Add
force
/merge
flag - Allow filtering of hidden files
- Update and unify how paths are defined on the remote and local system
- Add
- Refactor and extent tests
- Update documentation
Removed
- Remove
CSV
as dependecy and usereadlines
instead - Remove
FileWatching
,ArgTools
, andNetworkOptions
as dependency
Fixed
- Overload
walkdir
anddownload
instead of defining new functions - Ensure Windows paths are processed correctly
- Several fixes concerning the representation of paths (especially under Windows)
- Symlinks are now recognised by
stat
/statscan
walkdir
correctly follows symlinks