Merge #856

856: Minimal dependency versions + local check script + more r=Bromeon a=Bromeon

### Local `check.sh` script
Remove the outdated pre-commit hook, replaced with bash script to run checks locally.

You can execute this script to run tests, formatting, clippy etc.
All with the right settings as expected by our CI.

### Dependency policy
Dependencies in all `Cargo.toml` files have been downgraded to their minimum compatible version of the current major/minor branch (e.g. `2.1.3` -> `2`, `0.6.5` -> `0.6`). This increases compatibility with user dependencies, while still serving the latest versions (with bugfixes/improvements) to users by default.

Further:
* Add CI job to verify minimal dependency versions.
* Remove explicit versions for intra-dependencies (i.e. `0.9.3` when referring to another `gdnative` crate).
* Update parking_lot (0.11 -> 0.12) and glam (0.19 -> 0.20).


### Chores
* Fix nightly clippy yet another time
* Add `im` and `im-rc` to cargo-deny
* Minor changelog update
* Formatting in CI (semicolons)
* .gitignore update




Co-authored-by: Jan Haller <[email protected]>

Author: bors[bot]

.github/composite/rust/action.yml

@@ -11,6 +11,10 @@ inputs:
     required: false
     description: "Components array"
     default: ''
+  cache-key:
+    required: false
+    description: "Extra key to resolve cache"
+    default: ''
 
 runs:
   using: "composite"
@@ -24,3 +28,5 @@ runs:
 
     # For notes about the cache, see 'Full CI' workflow
     - uses: Swatinem/rust-cache@v1
+      with:
+        sharedKey: ${{ inputs.cache-key }}

.github/workflows/full-ci.yml

@@ -55,7 +55,7 @@ jobs:
         with:
           components: rustfmt
       - name: "Check rustfmt"
-        run: cargo fmt --all -- --check;
+        run: cargo fmt --all -- --check
 
   clippy:
     name: clippy${{ matrix.rust.postfix }}
@@ -77,7 +77,7 @@ jobs:
           rust: ${{ matrix.rust.toolchain }}
           components: clippy
       - name: "Check clippy"
-        run: cargo clippy --workspace --features ${GDRUST_FEATURES} -- -D clippy::style -D clippy::complexity -D clippy::perf -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented;
+        run: cargo clippy --workspace --features ${GDRUST_FEATURES} -- -D clippy::style -D clippy::complexity -D clippy::perf -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented
 
   cargo-deny:
     runs-on: ubuntu-latest
@@ -123,20 +123,34 @@ jobs:
           - os: { id: ubuntu-latest, name: linux }
             rust: { toolchain: '1.51', postfix: ' (msrv 1.51)' }
             testflags: '-- --skip ui_tests'
+          - os: { id: ubuntu-latest, name: linux }
+            rust: { toolchain: 'stable', postfix: ' (minimal-deps)', special: 'minimal-deps' }
     runs-on: ${{ matrix.os.id }}
     steps:
       - uses: actions/checkout@v2
+      - name: "Install nightly Rust (minimal-deps only)"
+        uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: false # use selected toolchain for remainder of this step
+          components: cargo
+        if: ${{ matrix.rust.special == 'minimal-deps' }}
+      - name: "Install minimal dependency versions from Cargo"
+        run: cargo +nightly update -Z minimal-versions
+        if: ${{ matrix.rust.special == 'minimal-deps' }}
       - name: "Install Rust"
         uses: ./.github/composite/rust
         with:
           rust: ${{ matrix.rust.toolchain }}
+          cache-key: ${{ matrix.rust.special }} # 'minimal-deps' or empty/not defined
       - name: "Install LLVM"
         uses: ./.github/composite/llvm
         if: ${{ matrix.os.id == 'windows-latest' }}
       - name: "Compile tests"
-        run: cargo test --workspace --features ${GDRUST_FEATURES} --no-run;
+        run: cargo test --workspace --features ${GDRUST_FEATURES} --no-run
       - name: "Test"
-        run: cargo test --workspace --features ${GDRUST_FEATURES} ${{ matrix.testflags }};
+        run: cargo test --workspace --features ${GDRUST_FEATURES} ${{ matrix.testflags }}
 
   build-release:
     name: build-release-${{ matrix.os.name }}
@@ -162,7 +176,7 @@ jobs:
         uses: ./.github/composite/llvm
         if: ${{ matrix.os.id == 'windows-latest' }}
       - name: "Release build (check only)"
-        run: cargo check --release;
+        run: cargo check --release
 
   build-ios:
     needs: rustfmt
@@ -179,21 +193,21 @@ jobs:
         #  rust: ${{ matrix.rust.toolchain }}
       - name: "Install cargo-dinghy"
         run: |
-          rustup target add x86_64-apple-ios;
-          curl -L https://github.com/sonos/dinghy/releases/download/0.4.62/cargo-dinghy-macos-0.4.62.tgz -o cargo-dinghy-macos.tar.gz;
-          tar -zxvf cargo-dinghy-macos.tar.gz;
-          mkdir -p $HOME/.cargo/bin;
-          cp cargo-dinghy-0.4.62/cargo-dinghy $HOME/.cargo/bin;
+          rustup target add x86_64-apple-ios
+          curl -L https://github.com/sonos/dinghy/releases/download/0.4.62/cargo-dinghy-macos-0.4.62.tgz -o cargo-dinghy-macos.tar.gz
+          tar -zxvf cargo-dinghy-macos.tar.gz
+          mkdir -p $HOME/.cargo/bin
+          cp cargo-dinghy-0.4.62/cargo-dinghy $HOME/.cargo/bin
       - name: "Cross-compile to iOS"
         run: |
-          RUNTIME_ID=$(xcrun simctl list runtimes | grep iOS | cut -d ' ' -f 7 | tail -1);
-          export SIM_ID=$(xcrun simctl create My-iphone11 com.apple.CoreSimulator.SimDeviceType.iPhone-11 $RUNTIME_ID);
-          xcrun simctl boot $SIM_ID;
-          cd gdnative-core;
-          cargo dinghy --platform auto-ios-x86_64 test;
-          cd ..;
-          cd gdnative-sys;
-          cargo dinghy --platform auto-ios-x86_64 test;
+          RUNTIME_ID=$(xcrun simctl list runtimes | grep iOS | cut -d ' ' -f 7 | tail -1)
+          export SIM_ID=$(xcrun simctl create My-iphone11 com.apple.CoreSimulator.SimDeviceType.iPhone-11 $RUNTIME_ID)
+          xcrun simctl boot $SIM_ID
+          cd gdnative-core
+          cargo dinghy --platform auto-ios-x86_64 test
+          cd ..
+          cd gdnative-sys
+          cargo dinghy --platform auto-ios-x86_64 test
 
   build-android:
     # Note: even though Android builds for another architecture than Linux, it can reuse downloaded crates (source code, maybe 'cargo check').
@@ -211,16 +225,16 @@ jobs:
         #  rust: ${{ matrix.rust.toolchain }}
       - name: "Install Java + NDK"
         run: |
-          # aarch64 and armv7 cover most Android phones & tablets.;
-          rustup target add aarch64-linux-android armv7-linux-androideabi;
-          sudo apt-get update;
-          sudo apt-get install llvm-dev libclang-dev clang g++-multilib gcc-multilib libc6-dev libc6-dev-arm64-cross;
+          # aarch64 and armv7 cover most Android phones & tablets.
+          rustup target add aarch64-linux-android armv7-linux-androideabi
+          sudo apt-get update
+          sudo apt-get install llvm-dev libclang-dev clang g++-multilib gcc-multilib libc6-dev libc6-dev-arm64-cross
       - name: "Build Rust for targets: aarch64-linux-android, armv7-linux-androideabi"
         run: |
           export CARGO_TARGET_AARCH64_LINUX_ANDROID_LINKER=$ANDROID_SDK_ROOT/ndk/$ANDROID_NDK_VERSION/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android21-clang++
           export CARGO_TARGET_ARMV7_LINUX_ANDROIDEABI_LINKER=$ANDROID_SDK_ROOT/ndk/$ANDROID_NDK_VERSION/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi21-clang++
-          cargo build --target aarch64-linux-android --release;
-          cargo build --target armv7-linux-androideabi --release;
+          cargo build --target aarch64-linux-android --release
+          cargo build --target armv7-linux-androideabi --release
         env:
           ANDROID_NDK_VERSION: 21.4.7075529
 

.github/workflows/minimal-ci.yml

@@ -40,7 +40,7 @@ jobs:
           rust: stable
           components: rustfmt
       - name: "Check rustfmt"
-        run: cargo fmt --all -- --check;
+        run: cargo fmt --all -- --check
 
   clippy:
     runs-on: ubuntu-latest
@@ -53,7 +53,7 @@ jobs:
           rust: stable
           components: clippy
       - name: "Check clippy"
-        run: cargo clippy --workspace --features ${GDRUST_FEATURES} -- -D clippy::style -D clippy::complexity -D clippy::perf -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented;
+        run: cargo clippy --workspace --features ${GDRUST_FEATURES} -- -D clippy::style -D clippy::complexity -D clippy::perf -D clippy::dbg_macro -D clippy::todo -D clippy::unimplemented
 
   unit-test:
     runs-on: ubuntu-latest
@@ -62,9 +62,9 @@ jobs:
       - name: "Install Rust"
         uses: ./.github/composite/rust
       - name: "Compile tests"
-        run: cargo test --workspace --features ${GDRUST_FEATURES} --no-run;
+        run: cargo test --workspace --features ${GDRUST_FEATURES} --no-run
       - name: "Test"
-        run: cargo test --workspace --features ${GDRUST_FEATURES};
+        run: cargo test --workspace --features ${GDRUST_FEATURES}
 
   integration-test-godot:
     runs-on: ubuntu-latest

.github/workflows/release-version.yml

@@ -38,15 +38,15 @@ jobs:
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_TOKEN }}
         run: |
-          (cd impl/proc_macros && cargo publish);
+          (cd impl/proc-macros && cargo publish);
           sleep 1m;
           (cd gdnative-sys && cargo publish);
           sleep 1m;
           (cd gdnative-derive && cargo publish);
           sleep 1m;
           (cd gdnative-core && cargo publish);
           sleep 1m;
-          (cd bindings_generator && cargo publish);
+          (cd bindings-generator && cargo publish);
           sleep 1m;
           (cd gdnative-bindings && cargo publish);
           sleep 1m;

.gitignore

@@ -1,15 +1,22 @@
-*/target
+# IDEs
+.vscode
+.idea
+
+# Build and package artifacts
 target
+*/target
 *.rlib
 **/Cargo.lock
-.vscode
-.idea
 
+# Godot
 # ignore all files in test/project/lib/, except the .gitkeep as the directory should still be there
 test/project/lib/*
 !test/project/lib/.gitkeep
-
 **/.import/*
+/logs
 
-#os specific
+# OS-specific
 .DS_Store
+
+# User stuff
+/ignore

CHANGELOG.md

@@ -83,7 +83,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 (Renames listed under _Changed_, safety removals under _Fixed_)
 
 - Crate features
-  - `nativescript` ([#812](https://github.com/godot-rust/godot-rust/pull/812))
+  - `nativescript` ([#811](https://github.com/godot-rust/godot-rust/pull/811))
   - `bindings` ([#833](https://github.com/godot-rust/godot-rust/pull/833))
 - All redundant or unnecessarily nested modules (see _Changed_)
 - Deprecated symbols ([#828](https://github.com/godot-rust/godot-rust/pull/828))
@@ -134,6 +134,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Automatic publishing of `master` docs ([#786](https://github.com/godot-rust/godot-rust/pull/786))
 - Issue templates ([#807](https://github.com/godot-rust/godot-rust/pull/807))
 - Add `cargo-deny` to CI ([#849](https://github.com/godot-rust/godot-rust/pull/849))
+- Add CI job which tests minimal dependencies ([#856](https://github.com/godot-rust/godot-rust/pull/856))
 
 
 ## [0.9.3] - 2021-02-02

CONTRIBUTING.md

@@ -1,70 +1,62 @@
-# Contributing to godot's rust bindings.
+# Contributing to the godot-rust library
 
 The godot-rust bindings developers welcome contribution from everyone. Here are the guidelines if you are thinking of helping us:
 
-## Contributions
 
-Contributions should be made in the form of GitHub pull requests (PRs). Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required.
+## Submitting a PR
 
-When opening a PR, our continuous integration (CI) pipeline will automatically perform a few basic checks (formatting, lints, unit tests). Please make sure those checks pass, adjusting your code if necessary.
+Contributions should be made in the form of GitHub pull requests (PRs). Each pull request will be reviewed by the godot-rust team or other contributors.
 
-Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.
 
-## Getting started
+### Picking a task
 
-Have a look at the [issues](https://github.com/godot-rust/godot-rust/issues) to find good tasks to start with.
+Have a look at the [issue tracker] to find good tasks to start with. Should you wish to work on an issue, please claim it first by commenting in it. This is to prevent duplicated efforts from contributors on the same issue.
 
-## Pull Request Checklist
+We especially appreciate input on the issues labeled [`help wanted`]. The label [`good first issue`] encompasses issues which do not require a deep prior knowledge of the godot-rust intricacies and could be picked up by a newcomer.
 
-- Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.
+You can also open a pull request directly without an associated issue. Note however that discussing the issue with other developers beforehand increases the chances of a PR being accepted, and may save time on both your and the reviewer's end. Such discussions can also happen in our Discord server.
 
-- Use one commit per logical change. Often, PRs only consist of a single commit. If you change unrelated parts of the code, split it into separate commits.
 
-- If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.
+### Git workflow
 
-- Whenever applicable, add tests relevant to the fixed bug or new feature.
+* Branch from the `master` branch and, if needed, rebase to the current `master` branch before submitting your pull request. If it doesn't merge cleanly, you may be asked to rebase your changes.
 
-- Use `cargo fmt` to format your code.
+* Use one commit per logical change. Often, PRs only consist of a single commit. If you change unrelated parts of the code, split it into separate commits.
 
-## Testing
+* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment.
 
-Everywhere: run `cargo test --workspace` from the root of the repository.
 
-On GNU/Linux operating systems:
+### Writing tests
 
-```
-cd test
-cargo build
-cp ../target/debug/libgdnative_test.so ./project/lib/
-godot --path ./project
-```
+Whenever applicable, add tests relevant to the fixed bug or new feature.
 
-The `godot` command in the above snippet is your local installation of godot and may vary depending on how it was installed.
+Some types and functions can only be used if the engine is running. In order to test them, use the `godot_test!` macro, and explicitly invoke the test functions in [test/src/lib.rs](test/src/lib.rs). Don't hesitate to see how existing code does this.
 
-### Automating tests
+  
+### Local and CI checks
 
-If you are on a bash-compatible system, you can use the `pre-commit.sh` to automatically run your tests every time you try to commit code.  You can install it with:
+The repository root contains a script `check.sh`. If you invoke it without arguments, it will run a list of basic checks locally. This tool also allows you to quickly build RustDoc documentation of changed APIs. Please run `./check.sh --help` for more information about its usage.
 
-```sh
-$ ln -s ../../hooks/pre-commit.sh .git/hooks/pre-commit
-$ chmod +x .git/hooks/pre-commit
-```
+If you use Windows, you might consider using a Unix shell interpreter (e.g. one shipped with Git-for-Windows, or WSL2, or similar).
 
-If you don't need to run tests on your commit, you can simply run `git commit --no-verify` to skip the pre-commit script.  The pre-commit script handles a few edge cases as well, by stashing all of your changes before running tests, just in case your unstashed changes mask errors in the bare commit.  This is especially useful if you've stopped working on something to make a quick patch.
+Additionally, when opening a PR, our continuous integration (CI) pipeline will automatically perform a few checks (formatting, lints, unit tests). Please make sure all of them pass, adjusting your code where necessary.
 
-## Writing tests
-
-Some types can only be used if the engine is running, in order to test them, use the `godot_test!` macro (see examples in [variant.rs](gdnative/src/variant.rs)), and explicitly invoke the test functions in [test/src/lib.rs](test/src/lib.rs).
 
 ## Communication
 
-Primary communication between developers of the project happens on the `godot-rust` Discord server. [Invite link here](https://discord.gg/FNudpBD).
+Primary communication between developers of the project happens on the `godot-rust` Discord server. [Invite link here][godot-rust-discord].
 
-For questions about using `godot-rust` the `#gdnative` channel on the [Godot Engine community Discord server](https://godotengine.org/community) can be used.
-On IRC the `#godotengine-gdnative` channel on freenode can be used for questions as well.
+For questions about Godot, check out the options on the [Godot community page][godot-community]. For example, their Discord server hosts a `#gdnative-dev` channel for questions regarding GDNative interface. The contributor chat is helpful in case of discussions about Godot's own design and implementation.
 
-If you are only interested in occasional announcements and showcases, follow [@GodotRust on Twitter](https://twitter.com/GodotRust). For questions and design discussions, please use Discord.
+If you are only interested in occasional announcements and showcases, follow [@GodotRust on Twitter][godot-rust-twitter]. For questions and design discussions, please use Discord.
 
 ## License
 
 Any contribution submitted for inclusion in the work by you shall be licensed under the [MIT license](LICENSE.md), without any additional terms or conditions.
+
+[issue tracker]: https://github.com/godot-rust/godot-rust/issues
+[`help wanted`]: https://github.com/godot-rust/godot-rust/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
+[`good first issue`]: https://github.com/godot-rust/godot-rust/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
+[godot-community]: https://godotengine.org/community
+[godot-rust-discord]: https://discord.gg/FNudpBD
+[godot-rust-twitter]: https://twitter.com/GodotRust

Cargo.toml

@@ -7,17 +7,17 @@ members = [
     "gdnative-derive",
     "gdnative-sys",
     "test",
-    "bindings_generator",
-    "examples/hello_world",
-    "examples/spinning_cube",
-    "examples/scene_create",
+    "bindings-generator",
+    "examples/hello-world",
+    "examples/spinning-cube",
+    "examples/scene-create",
     "examples/signals",
-    "examples/dodge_the_creeps",
+    "examples/dodge-the-creeps",
     "examples/resource",
-    "examples/native_plugin",
+    "examples/native-plugin",
     "examples/rpc",
-    "examples/array_export",
-    "impl/proc_macros"
+    "examples/array-export",
+    "impl/proc-macros"
 ]
 
 [profile.dev.package.miniserde]