Dev sync to main for 0.2.0

.cargo/config.toml

@@ -1,6 +1,15 @@
-[target.'cfg(target_os="linux")']
-# using mold breaks cargo cross on musl (the image is based on focal, which does not have a mold package)
-#rustflags = ["-C", "link-arg=-fuse-ld=mold"]
+[future-incompat-report]
+frequency = 'always'
+
+#[target.'cfg(target_os="linux")']
+# Caution! Unconditionally specifying mold breaks cargo cross on musl.
+#    (the base docker image cross uses is based on focal, which does not have a mold package)
+# So for now, we use defaults to not break CI.
+# To speed up local builds, set up your own ~/.cargo/config.toml something like this:
+#   [target.'cfg(target_os="linux")']
+#   linker = "clang-15"
+#   rustflags = ["-C", "link-arg=--ld-path=mold"]
+
 
 [target.'cfg(target_os="windows")']
 rustflags = ["-C", "link-arg=-fuse-ld=lld"] 

.github/workflows/ci.yml

@@ -12,7 +12,9 @@ on:
   workflow_dispatch:
 
 env:
+  BUILT_DEB_FILE: "invalid.deb" # updated by make-debian-package script
   CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
 
 jobs:
   # Build the app on all supported platforms, at least for the time being
@@ -39,7 +41,7 @@ jobs:
         toolchain: ${{ matrix.rust }}
         targets: ${{ matrix.target }}
     - name: Install tools
-      uses: taiki-e/install-action@v2.44.58
+      uses: taiki-e/install-action@v2.46.20
       with:
         tool: cross,cargo-deb
     #- name: Set minimal profile (Windows only)
@@ -56,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
@@ -98,10 +101,8 @@ jobs:
       - name: install packages
         run: scripts/install-ubuntu-packages
       # Checks begin here!
-      - run: cargo fmt --all -- --check
+      - run: cargo fmt --all --check
       - run: cargo test --locked
       - run: cargo clippy --locked --all-targets
-      # We care that the benchmarks build and run, not about their numeric output.
-      # To keep the CI a bit leaner, do this in the dev profile.
       - run: cargo build --locked --all-targets
       - run: cargo doc --no-deps --locked

.github/workflows/release.yml

@@ -6,7 +6,9 @@ on:
   workflow_dispatch: # for testing
 
 env:
+  BUILT_DEB_FILE: "invalid.deb" # updated by make-debian-package script
   CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
 
 permissions:
   contents: write
@@ -34,7 +36,7 @@ jobs:
       with:
         toolchain: ${{ matrix.rust }}
         targets: ${{ matrix.target }}
-    - uses: taiki-e/install-action@v2.44.58
+    - uses: taiki-e/install-action@v2.46.20
       with:
         tool: cross,cargo-deb
     - uses: Swatinem/rust-cache@v2
@@ -47,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' }}
@@ -71,9 +74,9 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: qcp-deb-${{ matrix.target }}
-        path: target/**/debian/qcp*.deb
+        path: ${{ env.BUILT_DEB_FILE }}
     - name: Publish deb package to release
-      if: ${{ github.event_name == 'release' }}
+      if: ${{ matrix.build_deb }} && ${{ github.event_name == 'release' }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       run: gh release upload ${{ github.ref_name }} ${{ env.BUILT_DEB_FILE }}

.vscode/launch.json

@@ -7,15 +7,15 @@
         {
             "type": "lldb",
             "request": "launch",
-            "name": "Debug executable 'qcpt'",
+            "name": "Debug executable 'qcp'",
             "cargo": {
                 "args": [
                     "build",
-                    "--bin=qcpt",
-                    "--package=qcpt"
+                    "--bin=qcp",
+                    "--package=qcp"
                 ],
                 "filter": {
-                    "name": "qcpt",
+                    "name": "qcp",
                     "kind": "bin"
                 }
             },
@@ -25,16 +25,16 @@
         {
             "type": "lldb",
             "request": "launch",
-            "name": "Debug unit tests in executable 'qcpt'",
+            "name": "Debug unit tests in executable 'qcp'",
             "cargo": {
                 "args": [
                     "test",
                     "--no-run",
-                    "--bin=qcpt",
-                    "--package=qcpt"
+                    "--bin=qcp",
+                    "--package=qcp"
                 ],
                 "filter": {
-                    "name": "qcpt",
+                    "name": "qcp",
                     "kind": "bin"
                 }
             },

.vscode/tasks.json

@@ -4,7 +4,7 @@
 		{
 			"type": "cargo",
 			"command": "doc",
-			"args": ["--no-deps"],
+			"args": ["--no-deps", "--locked"],
 			"problemMatcher": [
 				"$rustc"
 			],
@@ -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"
 		}
 	]
 }

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to QCP
+
+## 🐛 Bug reports & Feature requests
+
+Bug reports and feature requests are welcome, please open an [issue].
+
+- It may be useful to check the [issues list] and the [discussions] first in case somebody else has already raised it.
+- Please be aware that I mostly work on this project in my own time.
+
+## 🏗️ Pull request policy
+
+If you're thinking of contributing something non-trivial, it might be best to raise it in [discussions] first so you can get feedback early. This is particularly important for new features, to ensure they are aligned with the project goals and your approach is suitable.
+
+* Changes should normally be based on the `dev` branch. _(Exception: hotfixes may be branched against `main`.)_
+* PRs must pass the full set of CI checks (see below). No exceptions.
+* Unit tests are encouraged, particularly those which fail before and pass after a fix.
+* Refactoring for its own sake is OK if driven by a feature or bugfix.
+* Clean commit histories are preferred, but don't be discouraged if you don't know how to do this. git can be a tricky tool.
+* Commit messages should follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+  * Begin the commit message for a feature with `feat:`. If it's a bugfix, use `fix:`. 
+  * For a full list of supported message tags, look at `commit_parsers` in [release-plz.toml](release-plz.toml).
+  * This policy is in force since release 0.1.0. Earlier commits are considered grandfathered in.
+* Where there is an issue number, commit messages should reference it, e.g. (#12)
+* Do not edit CHANGELOG.md, that will be done for you on release.
+
+## ☑️ CI checks applied
+
+| Check | How to run it yourself | Notes |
+| ----- | ---------------------- | ----- |
+| Code style | `cargo fmt --all --check` | For VS Code users, `editor.formatOnSave=true` is set |
+| Everything must build | `cargo build --all-targets` |
+| Unit tests pass | `cargo test` |
+| Lints | `cargo clippy --all-targets` | This is a reasonably pedantic set of lints, which I make no apologies for |
+| Docs build | `cargo doc --no-deps` |
+
+
+[issue]: https://github.com/crazyscot/qcp/issues/new/choose
+[issues list]: https://github.com/crazyscot/qcp/issues
+[discussions]: https://github.com/crazyscot/qcp/discussions