Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mostly docs updates, with some features/fixes identified during the update #26

Merged
merged 9 commits into from
Dec 26, 2024
3 changes: 2 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,15 @@ jobs:

#- name: Build
# run: cross build --release --locked --target ${{ matrix.target }}
- uses: taiki-e/upload-rust-binary-action@v1.22.1
- uses: taiki-e/upload-rust-binary-action@v1.24.0
id: build
with:
bin: qcp
token: ${{ secrets.GITHUB_TOKEN }}
target: ${{ matrix.target }}
include: README.md,LICENSE,CHANGELOG.md
leading-dir: true
locked: true
tar: unix
zip: windows
dry_run: true
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,15 @@ jobs:

#- name: Build
# run: cross build --release --locked --target ${{ matrix.target }}
- uses: taiki-e/upload-rust-binary-action@v1.22.1
- uses: taiki-e/upload-rust-binary-action@v1.24.0
id: build
with:
bin: qcp
token: ${{ secrets.GITHUB_TOKEN }}
target: ${{ matrix.target }}
include: README.md,LICENSE,CHANGELOG.md
leading-dir: true
locked: true
tar: unix
zip: windows
dry_run: ${{ github.event_name != 'release' }}
Expand Down
13 changes: 13 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,19 @@
"isDefault": false
},
"label": "rust: cargo doc"
},
{
"type": "cargo",
"command": "doc",
"args": ["--no-deps", "--locked", "--document-private-items"],
"problemMatcher": [
"$rustc"
],
"group": {
"kind": "build",
"isDefault": false
},
"label": "rust: cargo doc --document-private-items"
}
]
}
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ rustls-pki-types = "1.10.0"
serde = { version = "1.0.216", features = ["derive"] }
static_assertions = "1.1.0"
struct-field-names-as-array = "0.3.0"
strum_macros = "0.26.4"
strum = { version = "0.26.3", features = ["derive"]}
tabled = "0.17.0"
tokio = { version = "1.42.0", default-features = true, features = ["fs", "io-std", "macros", "process", "rt", "time", "sync"] }
tokio-util = { version = "0.7.13", features = ["compat"] }
Expand Down Expand Up @@ -134,6 +134,8 @@ assets = [
[ "misc/changelog.gz", "usr/share/doc/qcp/", "644" ],
[ "misc/20-qcp.conf", "etc/sysctl.d/", "644" ], # this is automatically recognised as a conffile
[ "misc/qcp.1", "usr/share/man/man1/", "644" ],
[ "misc/qcp_config.5", "usr/share/man/man5/", "644" ],
[ "misc/qcp.conf", "etc/", "644" ], # this is automatically recognised as a conffile
]
maintainer-scripts="debian"
depends = "$auto,debconf"
3 changes: 3 additions & 0 deletions MAINTENANCE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
## Creating a release

* Create PR:
* _(Optional)_ `release-plz update` to preview updates to the changelog and version
* ```release-plz release-pr --git-token $GITHUB_QCP_TOKEN```
* _if this token has expired, you'll need to generate a fresh one; walk back through the release-plz setup steps_
* Review changelog, edit if necessary.
* Merge the PR (rebase strategy preferred)
* Delete the PR branch
* `git fetch && git merge --ff-only`
* Finalise the release:
* ```release-plz release --git-token $GITHUB_QCP_TOKEN```
* Check the new (draft) Github release page; update notes as necessary, publish when ready (when artifacts have all uploaded).
* Merge `dev` into `main`, or whatever suits the current branching strategy
* Check the docs built, follow up on the release workflow, etc.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,17 @@ $ qcp my-server:/tmp/testfile /tmp/
testfile ████████████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░ 1s @ 6.71 MB/s [10.49 MB]
```

**The program uses the ssh binary on your system to connect to the target machine**.
Things you should know:

* **qcp uses the ssh binary on your system to connect to the target machine**.
ssh will check the remote host key and prompt you for a password or passphrase in the usual way.

* **qcp will read your ssh config file** to resolve any Hostname aliases you may have defined there.
The idea is, if you can `ssh` to a host, you should also be able to `qcp` to it.
However, some particularly complicated ssh config files may be too much for qcp to understand.
(In particular, `Match` directives are not currently supported.)
In that case, you can use `--ssh-config` to provide an alternative configuration (or set it in your qcp configuration file).

#### Tuning

By default qcp is tuned for a 100Mbit connection, with 300ms round-trip time to the target server.
Expand Down
Loading
Loading