Skip to content

Commit e1b7a90

Browse files
authored
Merge pull request #24 from LIM-AeroCloud/rel/0.2.1
Rel/0.2.1
2 parents dc6ddf6 + 84bea2f commit e1b7a90

File tree

7 files changed

+40
-7
lines changed

7 files changed

+40
-7
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
44
The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
55

6+
## [v0.2.1] - 2025-08-23
7+
8+
## Changed
9+
10+
- Documentation updates and fixes (improved installation instructions, removed all references to
11+
URI type piracy; [#24])
12+
613
## [v0.2.0] - 2025-08-22
714

815
### Changed
@@ -130,6 +137,7 @@ All changes for this released are documented in respect to this version.
130137
[v0.1.1]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.1
131138
[v0.1.2]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.2
132139
[v0.2.0]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.0
140+
[v0.2.1]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.1
133141
[#8]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/8
134142
[#9]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/9
135143
[#10]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/10
@@ -138,3 +146,4 @@ All changes for this released are documented in respect to this version.
138146
[#18]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/18
139147
[#21]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/21
140148
[#22]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/22
149+
[#24]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/24

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "SFTP"
22
uuid = "f44f501d-421f-4286-bfa3-132bd4e9b35e"
33
authors = ["Peter Bräuer <pb866.git@gmail.com>"]
4-
version = "0.2.0"
4+
version = "0.2.1"
55

66
[deps]
77
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ makedocs(
1515
sitename="SFTP.jl Documentation",
1616
checkdocs=:public,
1717
format=Documenter.HTML(;
18+
prettyurls=false,
1819
canonical="https://LIM-AeroCloud.github.io/SFTP.jl",
1920
edit_link="dev",
2021
assets=String[],

docs/src/filesystem.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ functions, respectively, however, _SFTP.jl_'s functionality might be reduced.
99

1010
Several of the Filesystem functions return a `URI` struct from the
1111
[URIs package](https://github.com/JuliaWeb/URIs.jl.git) to represent the complete
12-
server address including the path on the server. `URI` structs are also accepted as
13-
input argument by serveral of _SFTP.jl_'s Filesystem functions.
12+
server address including the path on the server.
1413
For easier handling, the `URI` struct is exported by _SFTP.jl_ as well. See
1514
[URIs' documentation](https://docs.juliahub.com/URIs/eec2u/1.5.1/#URIs.URI)
1615
for more details on the `URI` struct.

docs/src/index.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,27 @@ to the typical Linux functionality exist to explore the SFTP server.
2222

2323
## SFTP Installation
2424

25-
Install using the package manager:
25+
_SFTP.jl_ is an unregistered Julia package, but can be installed with the package manager:
2626

27-
```julia
27+
```console
2828
julia> ]
2929

30-
pkg> add SFTP
30+
pkg> add https://github.com/LIM-AeroCloud/SFTP.jl.git
31+
```
32+
33+
By default, the development version will be install. To use released stable version switch to
34+
the `main` channel by installing _SFTP.jl_ with:
35+
36+
```console
37+
pkg> add https://github.com/LIM-AeroCloud/SFTP.jl.git#main
38+
```
39+
40+
The package is developed for MacOS and Linux, but can be used under Windows as well.
41+
It is tested against the long-term support version (LTS) of Julia, the latest stable version,
42+
and the nightly version. To run test on your system open the package manager and type `test`:
43+
44+
```console
45+
pkg> test
3146
```
3247

3348
## Contents

docs/src/release-notes.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ EditURL = "https://github.com/LIM-AeroCloud/SFTP.jl/blob/master/CHANGELOG.md"
77
This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
88
The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
99

10+
## [v0.2.1](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.1) - 2025-08-23
11+
12+
## Changed
13+
14+
- Documentation updates and fixes (improved installation instructions, removed all references to
15+
URI type piracy; [#24](https://github.com/LIM-AeroCloud/SFTP.jl/issues/24))
16+
1017
## [v0.2.0](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.0) - 2025-08-22
1118

1219
### Changed

src/filesystem.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,9 @@ updated path. Any `path` components prior to an absolute `path` are dropped.
391391
392392
!!! note
393393
The `uri` field of the `sftp` client remains unaffected by joinpath.
394-
Use `sftp.uri = joinpath(sftp, "new/path")` to update the URI on the `sftp` server.
394+
Use `sftp.uri = joinpath(sftp, "new/path", "parts")` or
395+
`cd(sftp, joinpath(sftp, joinpath("new/path", "parts")))` to update
396+
the URI on the `sftp` server.
395397
"""
396398
Base.joinpath(sftp::Client, path::AbstractString...)::URI = joinpath(sftp, string.(path...))
397399
Base.joinpath(sftp::Client, path::String...)::URI = joinpath(sftp.uri, path...)

0 commit comments

Comments
 (0)